jopt.csp.spi.arcalgorithm.variable
Class VarMath

java.lang.Object
  jopt.csp.spi.arcalgorithm.variable.VarMath

All Implemented Interfaces:

jopt.csp.variable.CspMath

public class VarMath

extends java.lang.Object

implements jopt.csp.variable.CspMath

Utility class for creating advanced mathematical expressions.

Constructor Summary

VarMath()
Constructor

Method Summary

jopt.csp.variable.CspDoubleExpr	abs(jopt.csp.variable.CspDoubleExpr expr)
jopt.csp.variable.CspFloatExpr	abs(jopt.csp.variable.CspFloatExpr expr)
jopt.csp.variable.CspIntExpr	abs(jopt.csp.variable.CspIntExpr expr)
jopt.csp.variable.CspLongExpr	abs(jopt.csp.variable.CspLongExpr expr)
jopt.csp.variable.CspDoubleExpr	acos(jopt.csp.variable.CspDoubleExpr x)
jopt.csp.variable.CspDoubleExpr	add(int a, jopt.csp.variable.CspDoubleExpr bexpr)
jopt.csp.variable.CspFloatExpr	add(int a, jopt.csp.variable.CspFloatExpr bexpr)
jopt.csp.variable.CspIntExpr	add(int a, jopt.csp.variable.CspIntExpr bexpr)
jopt.csp.variable.CspLongExpr	add(int a, jopt.csp.variable.CspLongExpr bexpr)
jopt.csp.variable.CspConstraint	allDifferent(jopt.csp.variable.CspGenericIntExpr expr) Constraints all elements of a generic variable to be a different value
jopt.csp.variable.CspConstraint	allDifferent(jopt.csp.variable.CspGenericLongExpr expr) Constraints all elements of a generic variable to be a different value
jopt.csp.variable.CspConstraint	allDifferent(jopt.csp.variable.CspIntExpr[] exprs) Returns a constraint that constraints an array of variables to be different
jopt.csp.variable.CspConstraint	allDifferent(jopt.csp.variable.CspLongExpr[] exprs) Returns a constraint that constraints an array of variables to be different
jopt.csp.variable.CspDoubleExpr	asin(jopt.csp.variable.CspDoubleExpr x)
jopt.csp.variable.CspDoubleExpr	atan(jopt.csp.variable.CspDoubleExpr x)
jopt.csp.variable.CspDoubleExpr	cos(jopt.csp.variable.CspDoubleExpr x)
jopt.csp.variable.CspDoubleExpr	divide(int a, jopt.csp.variable.CspDoubleExpr bexpr)
jopt.csp.variable.CspFloatExpr	divide(int a, jopt.csp.variable.CspFloatExpr bexpr)
jopt.csp.variable.CspIntExpr	divide(int a, jopt.csp.variable.CspIntExpr bexpr)
jopt.csp.variable.CspLongExpr	divide(int a, jopt.csp.variable.CspLongExpr bexpr)
jopt.csp.variable.CspDoubleExpr	exp(jopt.csp.variable.CspDoubleExpr x)
jopt.csp.variable.CspConstraint	globalCardCount(jopt.csp.variable.CspGenericIntExpr expr, java.lang.Number[] vals, jopt.csp.variable.CspIntExpr[] count) Constraints all elements of a generic variable to be a different value
jopt.csp.variable.CspConstraint	globalCardCount(jopt.csp.variable.CspGenericLongExpr expr, java.lang.Number[] vals, jopt.csp.variable.CspIntExpr[] count) Constraints all elements of a generic variable to be a different value
jopt.csp.variable.CspConstraint	globalCardCount(jopt.csp.variable.CspIntExpr[] exprs, java.lang.Number[] vals, jopt.csp.variable.CspIntExpr[] count) Returns a constraint that constraints an array of variables to be different
jopt.csp.variable.CspConstraint	globalCardCount(jopt.csp.variable.CspLongExpr[] exprs, java.lang.Number[] vals, jopt.csp.variable.CspIntExpr[] count) Returns a constraint that constraints an array of variables to be different
jopt.csp.variable.CspConstraint	globalCardinality(jopt.csp.variable.CspGenericIntExpr expr, java.lang.Number[] vals, int[] lb, int[] ub) Constraints all elements of a generic variable to be a different value
jopt.csp.variable.CspConstraint	globalCardinality(jopt.csp.variable.CspGenericLongExpr expr, java.lang.Number[] vals, int[] lb, int[] ub) Constraints all elements of a generic variable to be a different value
jopt.csp.variable.CspConstraint	globalCardinality(jopt.csp.variable.CspIntExpr[] exprs, java.lang.Number[] vals, int[] lb, int[] ub) Returns a constraint that constraints an array of variables to be different
jopt.csp.variable.CspConstraint	globalCardinality(jopt.csp.variable.CspLongExpr[] exprs, java.lang.Number[] vals, int[] lb, int[] ub) Returns a constraint that constraints an array of variables to be different
static java.lang.String	indicesToString(GenericIndex[] indices, boolean includeVal) Converts an array of indices to a string for generating names
jopt.csp.variable.CspDoubleExpr	log(jopt.csp.variable.CspDoubleExpr x)
jopt.csp.variable.CspConstraint	memberOfArray(jopt.csp.variable.CspIntExpr[] sources, jopt.csp.variable.CspIntExpr expr)
jopt.csp.variable.CspConstraint	memberOfArray(jopt.csp.variable.CspLongExpr[] sources, jopt.csp.variable.CspLongExpr expr)
jopt.csp.variable.CspDoubleExpr	multiply(int a, jopt.csp.variable.CspDoubleExpr bexpr)
jopt.csp.variable.CspFloatExpr	multiply(int a, jopt.csp.variable.CspFloatExpr bexpr)
jopt.csp.variable.CspIntExpr	multiply(int a, jopt.csp.variable.CspIntExpr bexpr)
jopt.csp.variable.CspLongExpr	multiply(int a, jopt.csp.variable.CspLongExpr bexpr)
jopt.csp.variable.CspConstraint	notMemberOfArray(jopt.csp.variable.CspIntExpr[] sources, jopt.csp.variable.CspIntExpr expr)
jopt.csp.variable.CspConstraint	notMemberOfArray(jopt.csp.variable.CspLongExpr[] sources, jopt.csp.variable.CspLongExpr expr)
jopt.csp.variable.CspDoubleExpr	power(jopt.csp.variable.CspDoubleExpr x, jopt.csp.variable.CspDoubleExpr p)
jopt.csp.variable.CspDoubleExpr	power(jopt.csp.variable.CspDoubleExpr x, double p)
jopt.csp.variable.CspDoubleExpr	power(double x, jopt.csp.variable.CspDoubleExpr p)
jopt.csp.variable.CspDoubleExpr	sin(jopt.csp.variable.CspDoubleExpr x)
jopt.csp.variable.CspDoubleExpr	square(jopt.csp.variable.CspDoubleExpr expr)
jopt.csp.variable.CspFloatExpr	square(jopt.csp.variable.CspFloatExpr expr)
jopt.csp.variable.CspIntExpr	square(jopt.csp.variable.CspIntExpr expr)
jopt.csp.variable.CspLongExpr	square(jopt.csp.variable.CspLongExpr expr)
jopt.csp.variable.CspDoubleExpr	subtract(int a, jopt.csp.variable.CspDoubleExpr bexpr)
jopt.csp.variable.CspFloatExpr	subtract(int a, jopt.csp.variable.CspFloatExpr bexpr)
jopt.csp.variable.CspIntExpr	subtract(int a, jopt.csp.variable.CspIntExpr bexpr)
jopt.csp.variable.CspLongExpr	subtract(int a, jopt.csp.variable.CspLongExpr bexpr)
jopt.csp.variable.CspDoubleExpr	summation(jopt.csp.variable.CspGenericDoubleExpr x, jopt.csp.variable.CspGenericIndex[] indexRange, jopt.csp.variable.CspGenericIndexRestriction sourceIdxRestriction) Creates a variable equal to the summation of values in the generic variable.
jopt.csp.variable.CspFloatExpr	summation(jopt.csp.variable.CspGenericFloatExpr x, jopt.csp.variable.CspGenericIndex[] indexRange, jopt.csp.variable.CspGenericIndexRestriction sourceIdxRestriction) Creates a variable equal to the summation of values in the generic variable.
jopt.csp.variable.CspIntExpr	summation(jopt.csp.variable.CspGenericIntExpr x, jopt.csp.variable.CspGenericIndex[] indexRange, jopt.csp.variable.CspGenericIndexRestriction sourceIdxRestriction) Creates a variable equal to the summation of values in the generic variable.
jopt.csp.variable.CspLongExpr	summation(jopt.csp.variable.CspGenericLongExpr x, jopt.csp.variable.CspGenericIndex[] indexRange, jopt.csp.variable.CspGenericIndexRestriction sourceIdxRestriction) Creates a variable equal to the summation of values in the generic variable.
jopt.csp.variable.CspDoubleExpr	tan(jopt.csp.variable.CspDoubleExpr x)
static GenericIndex[]	toGenericArray(jopt.csp.variable.CspGenericIndex[] indices) Converts an array of CSP indices to internal index objects
static NumExpr[]	toSpiExpressions(jopt.csp.variable.CspNumExpr[] exprs) Converts an array of api expressions to spi expressions
static IntExpr[]	toSpiIntExpressions(jopt.csp.variable.CspIntExpr[] exprs) Converts an array of api expressions to spi expressions
static int	totalGenericSize(GenericIndex[] indices) Returns the total number of values in a generic variable given a set of indices

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VarMath

public VarMath()

Constructor

Method Detail

add

public jopt.csp.variable.CspIntExpr add(int a,
                                        jopt.csp.variable.CspIntExpr bexpr)

Specified by:

add in interface jopt.csp.variable.CspMath

add

public jopt.csp.variable.CspLongExpr add(int a,
                                         jopt.csp.variable.CspLongExpr bexpr)

Specified by:

add in interface jopt.csp.variable.CspMath

add

public jopt.csp.variable.CspFloatExpr add(int a,
                                          jopt.csp.variable.CspFloatExpr bexpr)

Specified by:

add in interface jopt.csp.variable.CspMath

add

public jopt.csp.variable.CspDoubleExpr add(int a,
                                           jopt.csp.variable.CspDoubleExpr bexpr)

Specified by:

add in interface jopt.csp.variable.CspMath

subtract

public jopt.csp.variable.CspIntExpr subtract(int a,
                                             jopt.csp.variable.CspIntExpr bexpr)

Specified by:

subtract in interface jopt.csp.variable.CspMath

subtract

public jopt.csp.variable.CspLongExpr subtract(int a,
                                              jopt.csp.variable.CspLongExpr bexpr)

Specified by:

subtract in interface jopt.csp.variable.CspMath

subtract

public jopt.csp.variable.CspFloatExpr subtract(int a,
                                               jopt.csp.variable.CspFloatExpr bexpr)

Specified by:

subtract in interface jopt.csp.variable.CspMath

subtract

public jopt.csp.variable.CspDoubleExpr subtract(int a,
                                                jopt.csp.variable.CspDoubleExpr bexpr)

Specified by:

subtract in interface jopt.csp.variable.CspMath

multiply

public jopt.csp.variable.CspIntExpr multiply(int a,
                                             jopt.csp.variable.CspIntExpr bexpr)

Specified by:

multiply in interface jopt.csp.variable.CspMath

multiply

public jopt.csp.variable.CspLongExpr multiply(int a,
                                              jopt.csp.variable.CspLongExpr bexpr)

Specified by:

multiply in interface jopt.csp.variable.CspMath

multiply

public jopt.csp.variable.CspFloatExpr multiply(int a,
                                               jopt.csp.variable.CspFloatExpr bexpr)

Specified by:

multiply in interface jopt.csp.variable.CspMath

multiply

public jopt.csp.variable.CspDoubleExpr multiply(int a,
                                                jopt.csp.variable.CspDoubleExpr bexpr)

Specified by:

multiply in interface jopt.csp.variable.CspMath

divide

public jopt.csp.variable.CspIntExpr divide(int a,
                                           jopt.csp.variable.CspIntExpr bexpr)

Specified by:

divide in interface jopt.csp.variable.CspMath

divide

public jopt.csp.variable.CspLongExpr divide(int a,
                                            jopt.csp.variable.CspLongExpr bexpr)

Specified by:

divide in interface jopt.csp.variable.CspMath

divide

public jopt.csp.variable.CspFloatExpr divide(int a,
                                             jopt.csp.variable.CspFloatExpr bexpr)

Specified by:

divide in interface jopt.csp.variable.CspMath

divide

public jopt.csp.variable.CspDoubleExpr divide(int a,
                                              jopt.csp.variable.CspDoubleExpr bexpr)

Specified by:

divide in interface jopt.csp.variable.CspMath

abs

public jopt.csp.variable.CspIntExpr abs(jopt.csp.variable.CspIntExpr expr)

Specified by:

abs in interface jopt.csp.variable.CspMath

abs

public jopt.csp.variable.CspLongExpr abs(jopt.csp.variable.CspLongExpr expr)

Specified by:

abs in interface jopt.csp.variable.CspMath

abs

public jopt.csp.variable.CspFloatExpr abs(jopt.csp.variable.CspFloatExpr expr)

Specified by:

abs in interface jopt.csp.variable.CspMath

abs

public jopt.csp.variable.CspDoubleExpr abs(jopt.csp.variable.CspDoubleExpr expr)

Specified by:

abs in interface jopt.csp.variable.CspMath

square

public jopt.csp.variable.CspIntExpr square(jopt.csp.variable.CspIntExpr expr)

Specified by:

square in interface jopt.csp.variable.CspMath

square

public jopt.csp.variable.CspLongExpr square(jopt.csp.variable.CspLongExpr expr)

Specified by:

square in interface jopt.csp.variable.CspMath

square

public jopt.csp.variable.CspFloatExpr square(jopt.csp.variable.CspFloatExpr expr)

Specified by:

square in interface jopt.csp.variable.CspMath

square

public jopt.csp.variable.CspDoubleExpr square(jopt.csp.variable.CspDoubleExpr expr)

Specified by:

square in interface jopt.csp.variable.CspMath

power

public jopt.csp.variable.CspDoubleExpr power(jopt.csp.variable.CspDoubleExpr x,
                                             double p)

Specified by:

power in interface jopt.csp.variable.CspMath

power

public jopt.csp.variable.CspDoubleExpr power(jopt.csp.variable.CspDoubleExpr x,
                                             jopt.csp.variable.CspDoubleExpr p)

Specified by:

power in interface jopt.csp.variable.CspMath

power

public jopt.csp.variable.CspDoubleExpr power(double x,
                                             jopt.csp.variable.CspDoubleExpr p)

Specified by:

power in interface jopt.csp.variable.CspMath

exp

public jopt.csp.variable.CspDoubleExpr exp(jopt.csp.variable.CspDoubleExpr x)

Specified by:

exp in interface jopt.csp.variable.CspMath

log

public jopt.csp.variable.CspDoubleExpr log(jopt.csp.variable.CspDoubleExpr x)

Specified by:

log in interface jopt.csp.variable.CspMath

cos

public jopt.csp.variable.CspDoubleExpr cos(jopt.csp.variable.CspDoubleExpr x)

Specified by:

cos in interface jopt.csp.variable.CspMath

acos

public jopt.csp.variable.CspDoubleExpr acos(jopt.csp.variable.CspDoubleExpr x)

Specified by:

acos in interface jopt.csp.variable.CspMath

sin

public jopt.csp.variable.CspDoubleExpr sin(jopt.csp.variable.CspDoubleExpr x)

Specified by:

sin in interface jopt.csp.variable.CspMath

asin

public jopt.csp.variable.CspDoubleExpr asin(jopt.csp.variable.CspDoubleExpr x)

Specified by:

asin in interface jopt.csp.variable.CspMath

tan

public jopt.csp.variable.CspDoubleExpr tan(jopt.csp.variable.CspDoubleExpr x)

Specified by:

tan in interface jopt.csp.variable.CspMath

atan

public jopt.csp.variable.CspDoubleExpr atan(jopt.csp.variable.CspDoubleExpr x)

Specified by:

atan in interface jopt.csp.variable.CspMath

allDifferent

public jopt.csp.variable.CspConstraint allDifferent(jopt.csp.variable.CspIntExpr[] exprs)

Returns a constraint that constraints an array of variables to be different

Specified by:

allDifferent in interface jopt.csp.variable.CspMath

allDifferent

public jopt.csp.variable.CspConstraint allDifferent(jopt.csp.variable.CspLongExpr[] exprs)

Returns a constraint that constraints an array of variables to be different

Specified by:

allDifferent in interface jopt.csp.variable.CspMath

allDifferent

public jopt.csp.variable.CspConstraint allDifferent(jopt.csp.variable.CspGenericIntExpr expr)

Constraints all elements of a generic variable to be a different value

Specified by:

allDifferent in interface jopt.csp.variable.CspMath

allDifferent

public jopt.csp.variable.CspConstraint allDifferent(jopt.csp.variable.CspGenericLongExpr expr)

Constraints all elements of a generic variable to be a different value

Specified by:

allDifferent in interface jopt.csp.variable.CspMath

globalCardinality

public jopt.csp.variable.CspConstraint globalCardinality(jopt.csp.variable.CspIntExpr[] exprs,
                                                         java.lang.Number[] vals,
                                                         int[] lb,
                                                         int[] ub)

Returns a constraint that constraints an array of variables to be different

Specified by:

globalCardinality in interface jopt.csp.variable.CspMath

globalCardinality

public jopt.csp.variable.CspConstraint globalCardinality(jopt.csp.variable.CspLongExpr[] exprs,
                                                         java.lang.Number[] vals,
                                                         int[] lb,
                                                         int[] ub)

Returns a constraint that constraints an array of variables to be different

Specified by:

globalCardinality in interface jopt.csp.variable.CspMath

globalCardinality

public jopt.csp.variable.CspConstraint globalCardinality(jopt.csp.variable.CspGenericIntExpr expr,
                                                         java.lang.Number[] vals,
                                                         int[] lb,
                                                         int[] ub)

Constraints all elements of a generic variable to be a different value

Specified by:

globalCardinality in interface jopt.csp.variable.CspMath

globalCardinality

public jopt.csp.variable.CspConstraint globalCardinality(jopt.csp.variable.CspGenericLongExpr expr,
                                                         java.lang.Number[] vals,
                                                         int[] lb,
                                                         int[] ub)

Constraints all elements of a generic variable to be a different value

Specified by:

globalCardinality in interface jopt.csp.variable.CspMath

globalCardCount

public jopt.csp.variable.CspConstraint globalCardCount(jopt.csp.variable.CspIntExpr[] exprs,
                                                       java.lang.Number[] vals,
                                                       jopt.csp.variable.CspIntExpr[] count)

Returns a constraint that constraints an array of variables to be different

Specified by:

globalCardCount in interface jopt.csp.variable.CspMath

globalCardCount

public jopt.csp.variable.CspConstraint globalCardCount(jopt.csp.variable.CspLongExpr[] exprs,
                                                       java.lang.Number[] vals,
                                                       jopt.csp.variable.CspIntExpr[] count)

Returns a constraint that constraints an array of variables to be different

Specified by:

globalCardCount in interface jopt.csp.variable.CspMath

globalCardCount

public jopt.csp.variable.CspConstraint globalCardCount(jopt.csp.variable.CspGenericIntExpr expr,
                                                       java.lang.Number[] vals,
                                                       jopt.csp.variable.CspIntExpr[] count)

Constraints all elements of a generic variable to be a different value

Specified by:

globalCardCount in interface jopt.csp.variable.CspMath

globalCardCount

public jopt.csp.variable.CspConstraint globalCardCount(jopt.csp.variable.CspGenericLongExpr expr,
                                                       java.lang.Number[] vals,
                                                       jopt.csp.variable.CspIntExpr[] count)

Constraints all elements of a generic variable to be a different value

Specified by:

globalCardCount in interface jopt.csp.variable.CspMath

memberOfArray

public jopt.csp.variable.CspConstraint memberOfArray(jopt.csp.variable.CspIntExpr[] sources,
                                                     jopt.csp.variable.CspIntExpr expr)

Specified by:

memberOfArray in interface jopt.csp.variable.CspMath

memberOfArray

public jopt.csp.variable.CspConstraint memberOfArray(jopt.csp.variable.CspLongExpr[] sources,
                                                     jopt.csp.variable.CspLongExpr expr)

Specified by:

memberOfArray in interface jopt.csp.variable.CspMath

notMemberOfArray

public jopt.csp.variable.CspConstraint notMemberOfArray(jopt.csp.variable.CspIntExpr[] sources,
                                                        jopt.csp.variable.CspIntExpr expr)

Specified by:

notMemberOfArray in interface jopt.csp.variable.CspMath

notMemberOfArray

public jopt.csp.variable.CspConstraint notMemberOfArray(jopt.csp.variable.CspLongExpr[] sources,
                                                        jopt.csp.variable.CspLongExpr expr)

Specified by:

notMemberOfArray in interface jopt.csp.variable.CspMath

summation

public jopt.csp.variable.CspIntExpr summation(jopt.csp.variable.CspGenericIntExpr x,
                                              jopt.csp.variable.CspGenericIndex[] indexRange,
                                              jopt.csp.variable.CspGenericIndexRestriction sourceIdxRestriction)

Creates a variable equal to the summation of values in the generic variable. All indices in given range must exist in the variable X. If additional indices exist in X not used within the range, the returned expression will be a generic expression that is indexed on the leftover indices.

Specified by:

summation in interface jopt.csp.variable.CspMath

Parameters:

x - Generic variable summation is over

indexRange - Indices within generic variable X that summation is over

sourceIdxRestriction - Optional restriction of values placed on source index ranges

Returns:

Expression that is equal to summation of X

summation

public jopt.csp.variable.CspLongExpr summation(jopt.csp.variable.CspGenericLongExpr x,
                                               jopt.csp.variable.CspGenericIndex[] indexRange,
                                               jopt.csp.variable.CspGenericIndexRestriction sourceIdxRestriction)

Creates a variable equal to the summation of values in the generic variable. All indices in given range must exist in the variable X. If additional indices exist in X not used within the range, the returned expression will be a generic expression that is indexed on the leftover indices.

Specified by:

summation in interface jopt.csp.variable.CspMath

Parameters:

x - Generic variable summation is over

indexRange - Indices within generic variable X that summation is over

sourceIdxRestriction - Optional restriction of values placed on source index ranges

Returns:

Expression that is equal to summation of X

summation

public jopt.csp.variable.CspFloatExpr summation(jopt.csp.variable.CspGenericFloatExpr x,
                                                jopt.csp.variable.CspGenericIndex[] indexRange,
                                                jopt.csp.variable.CspGenericIndexRestriction sourceIdxRestriction)

Creates a variable equal to the summation of values in the generic variable. All indices in given range must exist in the variable X. If additional indices exist in X not used within the range, the returned expression will be a generic expression that is indexed on the leftover indices.

Specified by:

summation in interface jopt.csp.variable.CspMath

Parameters:

x - Generic variable summation is over

indexRange - Indices within generic variable X that summation is over

sourceIdxRestriction - Optional restriction of values placed on source index ranges

Returns:

Expression that is equal to summation of X

summation

public jopt.csp.variable.CspDoubleExpr summation(jopt.csp.variable.CspGenericDoubleExpr x,
                                                 jopt.csp.variable.CspGenericIndex[] indexRange,
                                                 jopt.csp.variable.CspGenericIndexRestriction sourceIdxRestriction)

Creates a variable equal to the summation of values in the generic variable. All indices in given range must exist in the variable X. If additional indices exist in X not used within the range, the returned expression will be a generic expression that is indexed on the leftover indices.

Specified by:

summation in interface jopt.csp.variable.CspMath

Parameters:

x - Generic variable summation is over

indexRange - Indices within generic variable X that summation is over

sourceIdxRestriction - Optional restriction of values placed on source index ranges

Returns:

Expression that is equal to summation of X

indicesToString

public static java.lang.String indicesToString(GenericIndex[] indices,
                                               boolean includeVal)

Converts an array of indices to a string for generating names

toSpiExpressions

public static NumExpr[] toSpiExpressions(jopt.csp.variable.CspNumExpr[] exprs)

Converts an array of api expressions to spi expressions

toSpiIntExpressions

public static IntExpr[] toSpiIntExpressions(jopt.csp.variable.CspIntExpr[] exprs)

Converts an array of api expressions to spi expressions

toGenericArray

public static GenericIndex[] toGenericArray(jopt.csp.variable.CspGenericIndex[] indices)

Converts an array of CSP indices to internal index objects

totalGenericSize

public static int totalGenericSize(GenericIndex[] indices)

Returns the total number of values in a generic variable given a set of indices