fr.cnes.sirius.patrius.math.optim

Class PointValuePair

java.lang.Object

fr.cnes.sirius.patrius.math.util.Pair<double[],Double>

fr.cnes.sirius.patrius.math.optim.PointValuePair

All Implemented Interfaces:

Serializable

public class PointValuePair
extends Pair<double[],Double>

This class holds a point and the value of an objective function at that point.

Since:

3.0

Version:

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

See Also:

PointVectorValuePair, MultivariateFunction, Serialized Form

Constructor Summary

Constructors

Constructor and Description
PointValuePair(double[] point, double value) Builds a point/objective function value pair.
PointValuePair(double[] point, double value, boolean copyArray) Builds a point/objective function value pair.

Method Summary

Modifier and Type	Method and Description
double[]	getPoint() Getter for the point.
double[]	getPointRef() Getter for the reference to the point.

Methods inherited from class fr.cnes.sirius.patrius.math.util.Pair

equals, getFirst, getKey, getSecond, getValue, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PointValuePair

public PointValuePair(double[] point,
                      double value)

Builds a point/objective function value pair.

Parameters:

point - Point coordinates. This instance will store a copy of the array, not the array passed as argument.

value - Value of the objective function at the point

PointValuePair

public PointValuePair(double[] point,
                      double value,
                      boolean copyArray)

Builds a point/objective function value pair.

Parameters:

point - Point coordinates

value - Value of the objective function at the point

copyArray - if true, the input array will be copied, otherwise it will be referenced

Method Detail

getPoint

public double[] getPoint()

Getter for the point.

Returns:

a copy of the stored point

getPointRef

public double[] getPointRef()

Getter for the reference to the point.

Returns:

the reference to the internal array storing the point