com.quantego.clp

Class CLPExpression

java.lang.Object

com.quantego.clp.CLPExpression

public class CLPExpression
extends java.lang.Object

Builder class to create the left-hand side of a CLPConstraint. Use CLP.createExpression() to create a new instance.

Author:

Nils Loehndorf

Method Summary

Methods

Modifier and Type	Method and Description
CLPExpression	add(CLPVariable... variable) Add the sum of multiple variables.
CLPExpression	add(CLPVariable variable, double value) Add a new term to the expression.
CLPExpression	add(double value) Add a constant term to the expression.
CLPExpression	add(double[] values, CLPVariable[] variables) Add the sum of multiple terms.
CLPExpression	add(double value, CLPVariable... variable) Add the sum of multiple variables, each multiplied by the same scalar.
CLPExpression	add(double value, CLPVariable variable) Add a new term to the expression.
CLPExpression	add(java.util.Map<CLPVariable,java.lang.Double> variables) Add the sum of multiple terms.
CLPObjective	asObjective() Set this expression as objective function of the CLP model.
CLPConstraint	eq(double value) Add this expression as equality constraint to the CLP model.
CLPConstraint	geq(double value) Add this expression as greater-or-equal constraint to the CLP model.
CLPConstraint	leq(double value) Add this expression as less-or-equal constraint to the CLP model.
CLPConstraint	neq(double value) Add this expression as not-equal constraint to the CLP model.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

add

public CLPExpression add(double value)

Add a constant term to the expression. Terms are collected automatically.

Parameters:

value -

Returns:

builder

add

public CLPExpression add(double value,
                CLPVariable variable)

Add a new term to the expression. Terms are collected automatically.

Parameters:

value -

variable -

Returns:

builder

add

public CLPExpression add(CLPVariable variable,
                double value)

Add a new term to the expression. Terms are collected automatically.

Parameters:

value -

variable -

Returns:

builder

add

public CLPExpression add(CLPVariable... variable)

Add the sum of multiple variables.

Parameters:

value -

variable -

Returns:

builder

add

public CLPExpression add(double value,
                CLPVariable... variable)

Add the sum of multiple variables, each multiplied by the same scalar.

Parameters:

value -

variable -

Returns:

builder

add

public CLPExpression add(double[] values,
                CLPVariable[] variables)

Add the sum of multiple terms.

Parameters:

value -

variable -

Returns:

builder

add

public CLPExpression add(java.util.Map<CLPVariable,java.lang.Double> variables)

Add the sum of multiple terms.

Parameters:

variables -

Returns:

builder

leq

public CLPConstraint leq(double value)

Add this expression as less-or-equal constraint to the CLP model.

Parameters:

value - right-hand side

Returns:

this expression as CLPConstraint

neq

public CLPConstraint neq(double value)

Add this expression as not-equal constraint to the CLP model.

Parameters:

value - right-hand side

Returns:

this expression as CLPConstraint

geq

public CLPConstraint geq(double value)

Add this expression as greater-or-equal constraint to the CLP model.

Parameters:

value - right-hand side

Returns:

this expression as CLPConstraint

eq

public CLPConstraint eq(double value)

Add this expression as equality constraint to the CLP model.

Parameters:

value - right-hand side

Returns:

this expression as CLPConstraint

asObjective

public CLPObjective asObjective()

Set this expression as objective function of the CLP model.

Returns:

this expression as CLPObjective

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object