Apache Commons Math 3.6.1 · org.apache.commons.math3.optim.linear.LinearObjectiveFunction

Modifier and Type	Field and Description
private final transient RealVector	coefficients Coefficients of the linear equation (c_i).
private final double	constantTerm Constant term of the linear equation.
private static final long	serialVersionUID Serializable version identifier.

Access	Constructor and Description
public	LinearObjectiveFunction(double[] Coefficients for the linear equation being optimized. coefficients, double Constant term of the linear equation. constantTerm)
public	LinearObjectiveFunction(RealVector Coefficients for the linear equation being optimized. coefficients, double Constant term of the linear equation. constantTerm)

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 linear equation being optimized. getCoefficients() Gets the coefficients of the linear equation being optimized.
public double	Returns: constant of the linear equation being optimized. getConstantTerm() Gets the constant of the linear equation being optimized.
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.
public double	Returns: the value of the linear equation at the current point. value(final double[] Point at which linear equation must be evaluated. point) Implements org.apache.commons.math3.analysis.MultivariateFunction.value. Computes the value of the linear equation at the current point.
public double	Returns: the value of the linear equation at the current point. value(final RealVector Point at which linear equation must be evaluated. point) Computes the value of the linear equation at the current point.
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

coefficients	back to summary
private final transient RealVector coefficients Coefficients of the linear equation (c_i).

constantTerm	back to summary
private final double constantTerm Constant term of the linear equation.

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

LinearObjectiveFunction	back to summary
public LinearObjectiveFunction(double[] coefficients, double constantTerm) Parameters coefficients:double[] Coefficients for the linear equation being optimized. constantTerm:double Constant term of the linear equation.

LinearObjectiveFunction	back to summary
public LinearObjectiveFunction(RealVector coefficients, double constantTerm) Parameters coefficients:RealVector Coefficients for the linear equation being optimized. constantTerm:double Constant term of the linear equation.

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() Gets the coefficients of the linear equation being optimized. Returns:RealVector coefficients of the linear equation being optimized.

getCoefficients

back to summary

public RealVector getCoefficients()

Gets the coefficients of the linear equation being optimized.

Returns:RealVector: coefficients of the linear equation being optimized.

getConstantTerm	back to summary
public double getConstantTerm() Gets the constant of the linear equation being optimized. Returns:double constant of the linear equation being optimized.

getConstantTerm

back to summary

public double getConstantTerm()

Gets the constant of the linear equation being optimized.

Returns:double: constant of the linear equation being optimized.

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

value	back to summary
public double value(final double[] point) Implements org.apache.commons.math3.analysis.MultivariateFunction.value. Computes the value of the linear equation at the current point. Parameters point:double[] Point at which linear equation must be evaluated. Returns:double the value of the linear equation at the current point.

value

back to summary

public double value(final double[] point)

Implements org.apache.commons.math3.analysis.MultivariateFunction.value.

Computes the value of the linear equation at the current point.

Parameters

point:double[]: Point at which linear equation must be evaluated.

Returns:double

the value of the linear equation at the current point.

value	back to summary
public double value(final RealVector point) Computes the value of the linear equation at the current point. Parameters point:RealVector Point at which linear equation must be evaluated. Returns:double the value of the linear equation at the current point.

value

back to summary

public double value(final RealVector point)

Computes the value of the linear equation at the current point.

Parameters

point:RealVector: Point at which linear equation must be evaluated.

Returns:double

the value of the linear equation at the current point.

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 LinearObjectiveFunction

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail