Package org.apache.commons.math4.legacy.optim

Class PointValuePair

java.lang.Object

org.apache.commons.math4.legacy.core.Pair<double[],Double>

org.apache.commons.math4.legacy.optim.PointValuePair

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

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

Since:

3.0

See Also:

PointVectorValuePair, MultivariateFunction

Constructor Summary

Constructors

Constructor	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	Description
boolean	equals(Object o)	Compare the specified object with this entry for equality.
double[]	getPoint()	Gets the point.
double[]	getPointRef()	Gets a reference to the point.
int	hashCode()	Compute a hash code.
String	toString()

Methods inherited from class org.apache.commons.math4.legacy.core.Pair

create, getFirst, getKey, getSecond, getValue

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()

Gets the point.

Returns:

a copy of the stored point.

getPointRef

public double[] getPointRef()

Gets a reference to the point.

Returns:

a reference to the internal array storing the point.

equals

public boolean equals(Object o)

Description copied from class: Pair

Compare the specified object with this entry for equality.

Overrides:

equals in class Pair<double[],Double>

Parameters:

o - Object.

Returns:

true if the given object is also a map entry and the two entries represent the same mapping.

hashCode

public int hashCode()

Description copied from class: Pair

Compute a hash code.

Overrides:

hashCode in class Pair<double[],Double>

Returns:

the hash code value.

toString

public String toString()

Description copied from class: Pair

Overrides:

toString in class Pair<double[],Double>