C++ API Reference
=================

The object-oriented C++ API allows you to integrate Kalis into your C++
application.

Modelling
---------

.. toctree::
    :maxdepth: 2

    classes/KProblem

Variables
^^^^^^^^^

.. toctree::
    :maxdepth: 2

    classes/KIntVar
    classes/KFloatVar
    classes/KNumVar

Constraints
^^^^^^^^^^^

.. toctree::
    :maxdepth: 2

    classes/KConstraint
    classes/KACBinConstraint
    classes/KACBinTableConstraint
    classes/KAbs
    classes/KAllDifferent
    classes/KBinTerm
    classes/KConditionNumLinComb
    classes/KConjunction
    classes/KConstraintArray
    classes/KCumulativeResourceConstraint
    classes/KCumulativeResourceConstraintResourceUsage
    classes/KCycle
    classes/KDisjunction
    classes/KDisjunctionArray
    classes/KDistanceEqualXyc
    classes/KDistanceGreaterThanXyc
    classes/KDistanceLowerThanXyc
    classes/KDistanceNotEqualXyc
    classes/KElement
    classes/KElement2D
    classes/KEltTerm
    classes/KEltTerm2D
    classes/KEqualXc
    classes/KEqualXyc
    classes/KEquiv
    classes/KGeneralizedArcConsistencyConstraint
    classes/KGeneralizedArcConsistencyTableConstraint
    classes/KGlobalCardinalityConstraint
    classes/KGreaterOrEqualXc
    classes/KGreaterOrEqualXyc
    classes/KGuard
    classes/KLessOrEqualXc
    classes/KLinComb
    classes/KLinTerm
    classes/KMax
    classes/KMin
    classes/KNonLinearTerm
    classes/KNotEqualXc
    classes/KNotEqualXyc
    classes/KNumDistanceEqualXyc
    classes/KNumDistanceGreaterThanXyc
    classes/KNumDistanceLowerThanXyc
    classes/KNumEqualXYZ
    classes/KNumEqualXYc
    classes/KNumEqualXc
    classes/KNumGreaterOrEqualXc
    classes/KNumGreaterOrEqualXyc
    classes/KNumLessOrEqualXc
    classes/KNumLinComb
    classes/KNumLowerOrEqualXyc
    classes/KNumNonLinearComb
    classes/KNumXEqualsAbsY
    classes/KNumXEqualsAtan2YZ
    classes/KNumXEqualsLnY
    classes/KNumXEqualsYArithPowC
    classes/KNumXEqualsYSquared
    classes/KNumXEqualsYTimesC
    classes/KNumXEqualsYTimesZ
    classes/KNumXOperatorACosY
    classes/KNumXOperatorASinY
    classes/KNumXOperatorATanY
    classes/KNumXOperatorCosY
    classes/KNumXOperatorExpY
    classes/KNumXOperatorLnY
    classes/KNumXOperatorSinY
    classes/KNumXOperatorTanY
    classes/KOccurTerm
    classes/KOccurrence
    classes/KTerm
    classes/KUnTerm
    classes/KUserConstraint
    classes/KUserNumConstraint
    classes/KXEqualYMinusZ


Scheduling
^^^^^^^^^^

.. toctree::
    :maxdepth: 2

    classes/KSchedule
    classes/KTask
    classes/KUnaryResource
    classes/KDiscreteResource
    classes/KResource
    classes/KResourceUsage
    classes/KTimeTable
    classes/KUnaryResourceConstraint


Solving
-------

.. toctree::
    :maxdepth: 2

    classes/KSolver
    classes/KSolution
    classes/KSolutionContainer
    classes/KSolverEventListener


Branching schemes
^^^^^^^^^^^^^^^^^

.. toctree::
    :maxdepth: 2

    classes/KBranchingScheme
    classes/KAssignAndForbid
    classes/KAssignVar
    classes/KBestBoundValue
    classes/KBranchingSchemeGroup
    classes/KBranchingSchemeGroupArray
    classes/KBranchingSchemeGroupSelector
    classes/KBranchingSchemeGroupSerializer
    classes/KDisjunctionInputOrder
    classes/KDisjunctionPriorityOrder
    classes/KDisjunctionSelector
    classes/KFloatVarBranchingScheme
    classes/KFloatVarSelector
    classes/KInputOrder
    classes/KIntervalDomain
    classes/KIntVarBranchingScheme
    classes/KLargestDomain
    classes/KLargestDurationDomain
    classes/KLargestEarliestCompletionTime
    classes/KLargestEarliestStartTime
    classes/KLargestLatestCompletionTime
    classes/KLargestLatestStartTime
    classes/KLargestMax
    classes/KLargestMin
    classes/KLargestReducedCost
    classes/KMaxDegree
    classes/KMaxRegretOnLowerBound
    classes/KMaxRegretOnUpperBound
    classes/KMaxToMin
    classes/KMiddle
    classes/KMinMaxConflict
    classes/KMinToMax
    classes/KMostFractional
    classes/KNearestNeighbor
    classes/KNearestRelaxedValue
    classes/KNearestValue
    classes/KNumInputOrder
    classes/KNumLargestReducedCost
    classes/KNumMiddle
    classes/KNumNearestRelaxedValue
    classes/KNumNearestValue
    classes/KNumSmallestDomain
    classes/KNumValueSelector
    classes/KNumVariableSelector
    classes/KPathOrder
    classes/KProbe
    classes/KProbeDisjunction
    classes/KRandomValue
    classes/KRandomVariable
    classes/KResourceSelector
    classes/KSettleDisjunction
    classes/KSmallestDomDegRatio
    classes/KSmallestDomain
    classes/KSmallestEarliestCompletionTime
    classes/KSmallestEarliestStartTime
    classes/KSmallestLatestCompletionTime
    classes/KSmallestLatestStartTime
    classes/KSmallestMax
    classes/KSmallestMin
    classes/KSmallestTargetStartTime
    classes/KSplitDomain
    classes/KSplitNumDomain
    classes/KTaskInputOrder
    classes/KTaskRandomOrder
    classes/KTaskSelector
    classes/KTaskSerializer
    classes/KValueSelector
    classes/KVariableSelector
    classes/KWidestDomain


Linear relaxation
^^^^^^^^^^^^^^^^^

.. toctree::
    :maxdepth: 2

    classes/KClpLinearRelaxationSolver
    classes/KCoinLinearRelaxationSolver
    classes/KLinearRelaxation
    classes/KLinearRelaxationSolver
    classes/KLinearRelaxationSolverConfigurator
    classes/KRelaxationSolver
    classes/KXPRSLinearRelaxationSolver


Environment
-----------

.. toctree::
    :maxdepth: 2

    classes/ArtelysException
    classes/Contradiction
    classes/KSession


Collections
-----------

.. toctree::
    :maxdepth: 2

    classes/KIntArray
    classes/KDoubleArray
    classes/KIntMatrix
    classes/KIntVarArray
    classes/KIntVarMatrix
    classes/KNumVarArray
    classes/KResourceArray
    classes/KResourceUsageArray
    classes/KTaskArray
    classes/KTupleArray
    classes/KBranchingSchemeArray
    classes/KSolutionArray