PointValuePair (Apache Commons Math 3.6.1 API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.commons.math3.util.Pair<double[],Double>
- - org.apache.commons.math3.optim.PointValuePair

All Implemented Interfaces:

Serializable
```
public class PointValuePair
extends Pair<double[],Double>
implements Serializable
```
This class holds a point and the value of an objective function at that point.

Since:

3.0

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

Methods
Modifier and Type Method and Description

double[] getPoint()
Gets the point.

double[] getPointRef()
Gets a reference to the point.
- Methods inherited from class org.apache.commons.math3.util.Pair
  create, 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()
```
    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.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2003–2016 The Apache Software Foundation. All rights reserved.