Apache Commons Math 3.6.1 · org.apache.commons.math3.optimization.linear.LinearConstraint

Modifier and Type	Field and Description
private final transient RealVector	coefficients Coefficients of the constraint (left hand side).
private final Relationship	relationship Deprecated as a consequence of `Relationship` being deprecated. Relationship between left and right hand sides (=, <=, >=).
private static final long	serialVersionUID Serializable version identifier.
private final double	value Value of the constraint (right hand side).

Constructor Summary

Access	Constructor and Description
public	LinearConstraint(final double[] The coefficients of the constraint (left hand side) coefficients, final Relationship The type of (in)equality used in the constraint relationship, final double The value of the constraint (right hand side) value) Deprecated as a consequence of `Relationship` being deprecated. Build a constraint involving a single linear equation.
public	LinearConstraint(final RealVector The coefficients of the constraint (left hand side) coefficients, final Relationship The type of (in)equality used in the constraint relationship, final double The value of the constraint (right hand side) value) Deprecated as a consequence of `Relationship` being deprecated. Build a constraint involving a single linear equation.
public	LinearConstraint(final double[] The coefficients of the linear expression on the left hand side of the constraint lhsCoefficients, final double The constant term of the linear expression on the left hand side of the constraint lhsConstant, final Relationship The type of (in)equality used in the constraint relationship, final double[] The coefficients of the linear expression on the right hand side of the constraint rhsCoefficients, final double The constant term of the linear expression on the right hand side of the constraint rhsConstant) Deprecated as a consequence of `Relationship` being deprecated. Build a constraint involving two linear equations.
public	LinearConstraint(final RealVector The coefficients of the linear expression on the left hand side of the constraint lhsCoefficients, final double The constant term of the linear expression on the left hand side of the constraint lhsConstant, final Relationship The type of (in)equality used in the constraint relationship, final RealVector The coefficients of the linear expression on the right hand side of the constraint rhsCoefficients, final double The constant term of the linear expression on the right hand side of the constraint rhsConstant) Deprecated as a consequence of `Relationship` being deprecated. Build a constraint involving two linear equations.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public RealVector	Returns: coefficients of the constraint (left hand side) getCoefficients() Get the coefficients of the constraint (left hand side).
public Relationship	Returns: relationship between left and right hand sides getRelationship() Deprecated as a consequence of `Relationship` being deprecated. Get the relationship between left and right hand sides.
public double	Returns: value of the constraint (right hand side) getValue() Get the value of the constraint (right hand side).
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
private void	readObject(ObjectInputStream stream from which the object should be read ois) Deserialize the instance.
private void	writeObject(ObjectOutputStream stream where object should be written oos) Serialize the instance.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

Field Detail

coefficients	back to summary
private final transient RealVector coefficients Coefficients of the constraint (left hand side).

relationship	back to summary
private final Relationship relationship Deprecated as a consequence of `Relationship` being deprecated. See corresponding docs for further information. Relationship between left and right hand sides (=, <=, >=).

serialVersionUID	back to summary
private static final long serialVersionUID Serializable version identifier.

value	back to summary
private final double value Value of the constraint (right hand side).

Constructor Detail

LinearConstraint back to summary

LinearConstraint	back to summary
public LinearConstraint(final double[] coefficients, final Relationship relationship, final double value) Deprecated as a consequence of `Relationship` being deprecated. See corresponding docs for further information. 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:double[] The coefficients of the constraint (left hand side) relationship:Relationship The type of (in)equality used in the constraint value:double The value of the constraint (right hand side)

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

Deprecated

as a consequence of Relationship being deprecated. See corresponding docs for further information.

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:double[]: The coefficients of the constraint (left hand side)
relationship:Relationship: The type of (in)equality used in the constraint
value:double: The value of the constraint (right hand side)

LinearConstraint back to summary

LinearConstraint	back to summary
public LinearConstraint(final RealVector coefficients, final Relationship relationship, final double value) Deprecated as a consequence of `Relationship` being deprecated. See corresponding docs for further information. 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:RealVector The coefficients of the constraint (left hand side) relationship:Relationship The type of (in)equality used in the constraint value:double The value of the constraint (right hand side)

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

Deprecated

as a consequence of Relationship being deprecated. See corresponding docs for further information.

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:RealVector: The coefficients of the constraint (left hand side)
relationship:Relationship: The type of (in)equality used in the constraint
value:double: The value of the constraint (right hand side)

LinearConstraint back to summary

LinearConstraint	back to summary
public LinearConstraint(final double[] lhsCoefficients, final double lhsConstant, final Relationship relationship, final double[] rhsCoefficients, final double rhsConstant) Deprecated as a consequence of `Relationship` being deprecated. See corresponding docs for further information. 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:double[] The coefficients of the linear expression on the left hand side of the constraint lhsConstant:double The constant term of the linear expression on the left hand side of the constraint relationship:Relationship The type of (in)equality used in the constraint rhsCoefficients:double[] The coefficients of the linear expression on the right hand side of the constraint rhsConstant:double The constant term of the linear expression on the right hand side of the constraint

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

Deprecated

as a consequence of Relationship being deprecated. See corresponding docs for further information.

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:double[]: The coefficients of the linear expression on the left hand side of the constraint
lhsConstant:double: The constant term of the linear expression on the left hand side of the constraint
relationship:Relationship: The type of (in)equality used in the constraint
rhsCoefficients:double[]: The coefficients of the linear expression on the right hand side of the constraint
rhsConstant:double: The constant term of the linear expression on the right hand side of the constraint

LinearConstraint back to summary

LinearConstraint	back to summary
public LinearConstraint(final RealVector lhsCoefficients, final double lhsConstant, final Relationship relationship, final RealVector rhsCoefficients, final double rhsConstant) Deprecated as a consequence of `Relationship` being deprecated. See corresponding docs for further information. 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:RealVector The coefficients of the linear expression on the left hand side of the constraint lhsConstant:double The constant term of the linear expression on the left hand side of the constraint relationship:Relationship The type of (in)equality used in the constraint rhsCoefficients:RealVector The coefficients of the linear expression on the right hand side of the constraint rhsConstant:double The constant term of the linear expression on the right hand side of the constraint

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

Deprecated

as a consequence of Relationship being deprecated. See corresponding docs for further information.

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:RealVector: The coefficients of the linear expression on the left hand side of the constraint
lhsConstant:double: The constant term of the linear expression on the left hand side of the constraint
relationship:Relationship: The type of (in)equality used in the constraint
rhsCoefficients:RealVector: The coefficients of the linear expression on the right hand side of the constraint
rhsConstant:double: The constant term of the linear expression on the right hand side of the constraint

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object other) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters other:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

other:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getCoefficients	back to summary
public RealVector getCoefficients() Get the coefficients of the constraint (left hand side). Returns:RealVector coefficients of the constraint (left hand side)

getCoefficients

back to summary

public RealVector getCoefficients()

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

Returns:RealVector: coefficients of the constraint (left hand side)

getRelationship back to summary

getRelationship	back to summary
public Relationship getRelationship() Deprecated as a consequence of `Relationship` being deprecated. See corresponding docs for further information. Get the relationship between left and right hand sides. Returns:Relationship relationship between left and right hand sides

public Relationship getRelationship()

Deprecated

as a consequence of Relationship being deprecated. See corresponding docs for further information.

Get the relationship between left and right hand sides.

Returns:Relationship: relationship between left and right hand sides

getValue	back to summary
public double getValue() Get the value of the constraint (right hand side). Returns:double value of the constraint (right hand side)

getValue

back to summary

public double getValue()

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

Returns:double: value of the constraint (right hand side)

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

readObject	back to summary
private void readObject(ObjectInputStream ois) throws ClassNotFoundException, IOException Deserialize the instance. Parameters ois:ObjectInputStream stream from which the object should be read Exceptions ClassNotFoundException: if a class in the stream cannot be found IOException: if object cannot be read from the stream

readObject

back to summary

private void readObject(ObjectInputStream ois) throws ClassNotFoundException, IOException

Deserialize the instance.

Parameters

ois:ObjectInputStream: stream from which the object should be read

Exceptions

ClassNotFoundException:: if a class in the stream cannot be found
IOException:: if object cannot be read from the stream

writeObject	back to summary
private void writeObject(ObjectOutputStream oos) throws IOException Serialize the instance. Parameters oos:ObjectOutputStream stream where object should be written Exceptions IOException: if object cannot be written to stream

writeObject

back to summary

private void writeObject(ObjectOutputStream oos) throws IOException

Serialize the instance.

Parameters

oos:ObjectOutputStream: stream where object should be written

Exceptions

IOException:: if object cannot be written to stream

public Class LinearConstraint

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail