Metadata-Version: 2.1
Name: jij-cimod
Version: 1.0.2
Summary: C++ library for a binary quadratic model
Home-page: https://openjij.github.io/OpenJij/
Author: Jij Inc.
Author-email: openjij@j-ij.com
License: Apache License 2.0
Description: # cimod : C++ header-only library for a binary quadratic model 
        
        * [Documents](https://openjij.github.io/cimod/html/index.html)
        
        # How to use
        
        You should just include a header `src/binary_quadratic_model.hpp` in your project.
        
        ## Example
        
        ### C++
        
        ```cpp
        #include "src/binary_quadratic_model.hpp"
        
        using namespace cimod;
        int main()
        {
        // Set linear biases and quadratic biases
        Linear<uint32_t, double> linear{ {1, 1.0}, {2, 2.0}, {3, 3.0}, {4, 4.0} };
        Quadratic<uint32_t, double> quadratic
        {
             {std::make_pair(1, 2), 12.0}, {std::make_pair(1, 3), 13.0}, {std::make_pair(1, 4), 14.0},
             {std::make_pair(2, 3), 23.0}, {std::make_pair(2, 4), 24.0},
             {std::make_pair(3, 4), 34.0}
         };
        
        // Set offset
        double offset = 0.0;
        
        // Set variable type
        Vartype vartype = Vartype::BINARY;
        // Create a BinaryQuadraticModel instance
        BinaryQuadraticModel<uint32_t, double> bqm(linear, quadratic, offset, vartype);
        
        // Print informations of bqm
        bqm.print();
        
        return 0;
        }
        ```
        
        ### Python
        
        ```python
        import cimod
        import dimod
        
        # Set linear biases and quadratic biases
        linear = {1:1.0, 2:2.0, 3:3.0, 4:4.0}
        quadratic = {(1,2):12.0, (1,3):13.0, (1,4):14.0, (2,3):23.0, (2,4):24.0, (3,4):34.0}
        
        # Set offset
        offset = 0.0
        
        # Set variable type
        vartype = dimod.BINARY
        
        # Create a BinaryQuadraticModel instance
        bqm = cimod.BinaryQuadraticModel(linear, quadratic, offset, vartype)
        
        # Print informations of bqm
        bqm.print()
        ```
        
        ## Install (via python)
        
        ```sh
        $ python setup.py install
        ```
        
        
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python
Description-Content-Type: text/markdown
