Subroutines

Topics covered in this chapter:

Constraints

abs	Absolute value constraint
all_different	All different constraint
and	Conjunction composite constraint
cplinctr	Linear constraints
cpnlinctr	Non-linear constraints
cumulative	Cumulative constraint
cycle	Cycle constraint
disjunctive	Disjunctive constraint
distance	Distance constraint
distribute	Distribute constraint with fixed bounds
dot	Dot product
element	Element constraint
equiv	Equivalence composite constraint
exp	Exponential of a non-linear expression
generic_binary_constraint	Generic Binary constraint
generic_nary_constraint	Generic nary constraint
implies	Implication composite constraint
ln	Natural logarithm of a non-linear expression
maximum_minimum	Maximum/minimum constraint
occurrence	Occurrence constraint
or	Disjunction composite constraint
producer_consumer	Producer Consumer constraint
table_constraint	Generic nary table constraint

Constraint parameters

getactivebranch	Gets the active branch of a disjunction
getarity	Returns the number of variables in the constraint
getpriority	Returns the priority of a constraint
gettag	Gets the tag of a constraint
setfirstbranch	Sets the first branch of a disjunction to be activated
setpriority	Sets the priority of a constraint
settag	Sets the tag of a constraint

Variables

contains	Tests if a value is in the domain of a variable
cp_show_var	Shows the current domain of the variable
cp_show_var_constraints	Shows the constraints of involved in the variable
getdegree	Returns the degree of a variable
getlb	Returns the current lower bound of a variable
getmiddle	Returns the middle value of a variable
getnext	Gets the next value in the domain of a finite domain variable
getprev	Gets the previous value in the domain of a finite domain variable
getrand	Returns a random value belonging to the domain of a variable
getsize	Returns the cardinality of the variable domain
gettarget	Returns the target value of a variable
getub	Returns the current upper bound of a variable
getval	Returns the instantiation value of a variable
is_equal	Tests if two variable domains are equal
is_fixed	Tests if the variable passed in argument is instantiated
is_same	Tests if two decision variables represent the same variable
setdomain	Sets the domain of a variable
setlb	Sets the lower bound of a variable
setprecision	Sets the precision relativity and value of a continuous variable
settarget	Sets the target value of a variable
setub	Sets the upper bound of a variable
setval	Instantiate the value of a variable

Problem

cp_find_next_sol	Finds the next solution of the problem
cp_infeas_analysis	Compute a minimal conflict set for an inconsistent problem
cp_local_optimize	Optimize an integer objective variable with local optimization.
cp_maximise	Alias for cp_maximize
cp_maximize	Maximizes a variable
cp_minimise	Alias for cp_minimize
cp_minimize	Minimizes a variable
cp_post	Posts a constraint to the problem
cp_propagate	Propagates the constraints
cp_reset_params	Reset parameters to their default value.
cp_reset_search	Resets the search process
cp_restore_state	Restore a solver state from the stack
cp_save_state	Save a marker in the stack
cp_shave	Shave the variables of the problem
cp_show_best_sol	Pretty printing of the best solution found.
cp_show_prob	Pretty printing of the problem
cp_show_sol	Pretty printing of the last solution.
getelt	Retrieve the value of a reversible array element.
getindex	Gets the index of a variable / task / resource
getname	Gets the name of a variable / task / resource
getsize	Returns the size of a reversible array.
getsol	Returns the solution value of a variable
getval	Retrieve the value of a reversible number.
path_order	Return a path-order branching scheme
set_reversible_attributes	Sets the attributes of a reversible number or array.
set_sol_as_target	Set last solution found as target values.
setelt	Set the value of an element of an array of reversibles.
setname	Sets the name of a variable / task / resource
setval	Set the value of a reversible number.

Search

assign_and_forbid	assign_and_forbid branching scheme
assign_var	assign_var branching scheme
bs_group	Create a group of branching schemes
cp_get_backtracks	Returns the number of backtracks of the current solver
cp_get_computation_time	Returns the computation time of the current solver
cp_get_depth	Returns the depth of the search tree of the current solver
cp_get_nb_solutions	Return the number of solutions already found for the problem.
cp_get_number_of_nodes	Returns the number of nodes in the search tree of the current solver
cp_get_total_backtracks	Returns the total number of backtracks of the scheduling solver
cp_get_total_computation_time	Returns the total computation time of the scheduling solver
cp_get_total_depth	Returns the total depth of the scheduling solver
cp_get_total_number_of_nodes	Returns the total number of nodes of the scheduling solver
cp_print_stats	Dumps in a CSV file some statistics about the search
cp_set_branching	Sets the strategy to use during the search for a solution
cp_show_stats	Shows some statistics about the search
gettag	Gets the tag associated with a branching scheme group
group_serializer	Creates a branching scheme Group Serializer
probe_assign_var	probe_assign_var branching scheme
probe_settle_disjunction	probe_settle_disjunction branching scheme
settle_disjunction	settle_disjunction branching scheme
split_domain	split_domain branching scheme
task_serialize	task_serialize branching scheme

Callbacks

cp_set_branch_callback	Sets the branch callback procedure
cp_set_node_callback	Sets the node callback procedure
cp_set_solution_callback	Sets the solution callback procedure

Scheduling

addpredecessors	Adds a set of predecessors for a task
addsuccessors	Adds a set of tasks as successors of a task
consumes	Sets the minimal and maximal amount of resource consumed by a task for a particular resource
cp_close_schedule	Close the schedule.
cp_get_default_schedule_strategy	Gets the default schedule search strategy of cp_schedule
cp_schedule	Optimizes the schedule with respect to an objective variable.
cp_set_schedule_strategy	Sets the schedule search strategy for cp_schedule
cp_show_schedule	Shows a textual representation of the current schedule
get_start_based_duration	Query for a start based duration value
getassignment	Gets the cpvar representing the assignment of a task for a particular resource.
getcapacity	Get the maximal capacity of a resource for a specific time period.
getconsumption	Gets the cpvar representing the consumption of a task for a particular resource
getduration	Gets the cpvar representing a task duration
getend	Gets the cpvar representing a task completion time
getmakespan	Gets the cpvar representing the makespan of the schedule.
getproduction	Gets the cpvar representing the production of a task for a particular resource
getprovision	Gets the cpvar representing the provision of a task for a particular resource
getrequirement	Gets the cpvar representing the requirement of a task for a particular resource
getsetuptime	Gets the sequence dependent setup times between two tasks
getstart	Gets the cpvar representing a task start time
has_assignment	Tests whether an assignment decision variable for a task and a particular resource exists.
is_consuming	Tests whether a task consumes a specific resource
is_fixed	Tests if a task is fixed
is_fixed	Tests if a disjunction is fixed
is_idletime	Tests if a timestep is an idle timestep for a resource.
is_producing	Tests whether a task produces a specific resource
is_providing	Tests whether a task provides a specific resource
is_requiring	Tests whether a task requires a specific resource
produces	Sets the minimal and maximal amount of resource produced by a task for a particular resource
provides	Sets the minimal and maximal amount of resource provided by a task for a particular resource.
requires	Sets the minimal and maximal amount of resource required by a task for a particular resource
resusage	Creates a resource usage
set_duration_with_idle_times	Set a duration constraint conditional to some idle time windows and on the task assignment.
set_resource_attributes	Sets some attributes for a resource
set_start_based_duration	Set a duration computed from the value taken by the start variable if the task is assigned to this resource.
set_task_attributes	Sets some attributes for a task
setcapacity	Sets the maximal capacity of a resource between two time bounds.
setduration	Sets the duration of a task
setidletimes	Specifies the set of timesteps where a resource is idle.
setmaxavailability	Sets the maximal capacity of a resource between two time bounds.
setminusage	Sets the minimum usage of a resource between two time bounds.
setpredecessors	Sets the tasks that must precede a task
setsetuptime	Sets sequence dependent setup times between two tasks
setsuccessors	Sets the set of tasks that must succeed a task
update_duration_with_idle_times	Set a duration constraint conditional to some idle time windows and on the task assignment.

Linear relaxations

cp_add_linrelax_solver	Add a linear relaxation solver to the linear relaxation solver list
cp_clear_linrelax_solver	Clear the linear relaxation solver list
cp_get_linrelax	Returns an automatic relaxation of the cp problem
cp_remove_linrelax_solver	Remove a linear relaxation solver from the linear relaxation solver list
cp_show_relax	Pretty printing of a linear relaxation
export_prob	Export the linear relaxation in LP format
fix_to_relaxed	Fix the continuous variables to their optimal value in the relaxation solver passed in argument
generate_cuts	Generate and add cuts to the relaxation passed in parameters
get_indicator	Get an indicator variable for a given variable and a value.
get_linrelax	Get the linear relaxation for a constraint
get_linrelax_solver	Returns a linear relaxation solver from a linear relaxation, an objective variables and some configuration parameters
get_reduced_cost	Get a reduced cost value from a linear relaxation solver
get_relaxed_value	Returns the optimal relaxed value for a variable in a relaxation
KALIS_LARGEST_REDUCED_COST	Get a largest reduced cost variable selector from a linear relaxation solver
KALIS_NEAREST_RELAXED_VALUE	Get a nearest relaxed value selector from a linear relaxation solver
lp_optimize	Launch LP/MIP solver without CP branching.
set_integer	Set integrality flag for a variable in a linear relaxation
set_linrelax_solver_attribute	Parameter setting for a linear relaxation solver.
set_verbose_level	Set the verbose level for a specific linear relaxation solver

© 2001-2023 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.

Contents

Index

Glossary

Search Results