PointValuePair (Apache Commons Math (Legacy) 4.0-SNAPSHOT API)

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`double[]`	`getPoint()`	Gets the point.
`double[]`	`getPointRef()`	Gets a reference to the point.
`int`	`hashCode()`
`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)
```
    Overrides:
    
    equals in class Pair<double[],Double>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Pair<double[],Double>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Pair<double[],Double>