fr.cnes.sirius.patrius.math.optim.linear

Class LinearObjectiveFunction

java.lang.Object

fr.cnes.sirius.patrius.math.optim.linear.LinearObjectiveFunction

All Implemented Interfaces:

MultivariateFunction, OptimizationData, Serializable

public class LinearObjectiveFunction
extends Object
implements MultivariateFunction, OptimizationData, Serializable

An objective function for a linear optimization problem.

A linear objective function has one the form:

 c1x1 + ... cnxn + d
 

The c_i and d are the coefficients of the equation, the x_i are the coordinates of the current point.

Since:

2.0

Version:

$Id: LinearObjectiveFunction.java 18108 2017-10-04 06:45:27Z bignon $

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LinearObjectiveFunction(double[] coefficientsIn, double constantTermIn)
LinearObjectiveFunction(RealVector coefficientsIn, double constantTermIn)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object other)
RealVector	getCoefficients() Gets the coefficients of the linear equation being optimized.
double	getConstantTerm() Gets the constant of the linear equation being optimized.
int	hashCode()
double	value(double[] point) Computes the value of the linear equation at the current point.
double	value(RealVector point) Computes the value of the linear equation at the current point.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LinearObjectiveFunction

public LinearObjectiveFunction(double[] coefficientsIn,
                       double constantTermIn)

Parameters:

coefficientsIn - Coefficients for the linear equation being optimized.

constantTermIn - Constant term of the linear equation.

LinearObjectiveFunction

public LinearObjectiveFunction(RealVector coefficientsIn,
                       double constantTermIn)

Parameters:

coefficientsIn - Coefficients for the linear equation being optimized.

constantTermIn - Constant term of the linear equation.

Method Detail

getCoefficients

public RealVector getCoefficients()

Gets the coefficients of the linear equation being optimized.

Returns:

coefficients of the linear equation being optimized.

getConstantTerm

public double getConstantTerm()

Gets the constant of the linear equation being optimized.

Returns:

constant of the linear equation being optimized.

value

public double value(double[] point)

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

Specified by:

value in interface MultivariateFunction

Parameters:

point - Point at which linear equation must be evaluated.

Returns:

the value of the linear equation at the current point.

value

public double value(RealVector point)

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

Parameters:

point - Point at which linear equation must be evaluated.

Returns:

the value of the linear equation at the current point.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object