org.apache.commons.math.optimization.linear

Class LinearConstraint

java.lang.Object

org.apache.commons.math.optimization.linear.LinearConstraint

All Implemented Interfaces:

java.io.Serializable

public class LinearConstraint
extends java.lang.Object
implements java.io.Serializable

A linear constraint for a linear optimization problem.

A linear constraint has one of the forms:

• c₁x₁ + ... c_nx_n = v
• c₁x₁ + ... c_nx_n <= v
• c₁x₁ + ... c_nx_n >= v
• l₁x₁ + ... l_nx_n + l_cst = r₁x₁ + ... r_nx_n + r_cst
• l₁x₁ + ... l_nx_n + l_cst <= r₁x₁ + ... r_nx_n + r_cst
• l₁x₁ + ... l_nx_n + l_cst >= r₁x₁ + ... r_nx_n + r_cst

The c_i, l_i or r_i are the coefficients of the constraints, the x_i are the coordinates of the current point and v is the value of the constraint.

Since:

2.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LinearConstraint(double[] lhsCoefficients, double lhsConstant, Relationship relationship, double[] rhsCoefficients, double rhsConstant) Build a constraint involving two linear equations.
LinearConstraint(double[] coefficients, Relationship relationship, double value) Build a constraint involving a single linear equation.
LinearConstraint(RealVector lhsCoefficients, double lhsConstant, Relationship relationship, RealVector rhsCoefficients, double rhsConstant) Build a constraint involving two linear equations.
LinearConstraint(RealVector coefficients, Relationship relationship, double value) Build a constraint involving a single linear equation.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)
RealVector	getCoefficients() Get the coefficients of the constraint (left hand side).
Relationship	getRelationship() Get the relationship between left and right hand sides.
double	getValue() Get the value of the constraint (right hand side).
int	hashCode()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LinearConstraint

public LinearConstraint(double[] coefficients,
                        Relationship relationship,
                        double value)

Build a constraint involving a single linear equation.

A linear constraint with a single linear equation has one of the forms:

• c₁x₁ + ... c_nx_n = v
• c₁x₁ + ... c_nx_n <= v
• c₁x₁ + ... c_nx_n >= v

Parameters:

coefficients - The coefficients of the constraint (left hand side)

relationship - The type of (in)equality used in the constraint

value - The value of the constraint (right hand side)

LinearConstraint

public LinearConstraint(RealVector coefficients,
                        Relationship relationship,
                        double value)

Build a constraint involving a single linear equation.

A linear constraint with a single linear equation has one of the forms:

• c₁x₁ + ... c_nx_n = v
• c₁x₁ + ... c_nx_n <= v
• c₁x₁ + ... c_nx_n >= v

Parameters:

coefficients - The coefficients of the constraint (left hand side)

relationship - The type of (in)equality used in the constraint

value - The value of the constraint (right hand side)

LinearConstraint

public LinearConstraint(double[] lhsCoefficients,
                        double lhsConstant,
                        Relationship relationship,
                        double[] rhsCoefficients,
                        double rhsConstant)

Build a constraint involving two linear equations.

A linear constraint with two linear equation has one of the forms:

• l₁x₁ + ... l_nx_n + l_cst = r₁x₁ + ... r_nx_n + r_cst
• l₁x₁ + ... l_nx_n + l_cst <= r₁x₁ + ... r_nx_n + r_cst
• l₁x₁ + ... l_nx_n + l_cst >= r₁x₁ + ... r_nx_n + r_cst

Parameters:

lhsCoefficients - The coefficients of the linear expression on the left hand side of the constraint

lhsConstant - The constant term of the linear expression on the left hand side of the constraint

relationship - The type of (in)equality used in the constraint

rhsCoefficients - The coefficients of the linear expression on the right hand side of the constraint

rhsConstant - The constant term of the linear expression on the right hand side of the constraint

LinearConstraint

public LinearConstraint(RealVector lhsCoefficients,
                        double lhsConstant,
                        Relationship relationship,
                        RealVector rhsCoefficients,
                        double rhsConstant)

Build a constraint involving two linear equations.

A linear constraint with two linear equation has one of the forms:

• l₁x₁ + ... l_nx_n + l_cst = r₁x₁ + ... r_nx_n + r_cst
• l₁x₁ + ... l_nx_n + l_cst <= r₁x₁ + ... r_nx_n + r_cst
• l₁x₁ + ... l_nx_n + l_cst >= r₁x₁ + ... r_nx_n + r_cst

Parameters:

lhsCoefficients - The coefficients of the linear expression on the left hand side of the constraint

lhsConstant - The constant term of the linear expression on the left hand side of the constraint

relationship - The type of (in)equality used in the constraint

rhsCoefficients - The coefficients of the linear expression on the right hand side of the constraint

rhsConstant - The constant term of the linear expression on the right hand side of the constraint

Method Detail

getCoefficients

public RealVector getCoefficients()

Get the coefficients of the constraint (left hand side).

Returns:

coefficients of the constraint (left hand side)

getRelationship

public Relationship getRelationship()

Get the relationship between left and right hand sides.

Returns:

relationship between left and right hand sides

getValue

public double getValue()

Get the value of the constraint (right hand side).

Returns:

value of the constraint (right hand side)

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object