diff options
author | Raymond <siuchow@google.com> | 2015-04-02 10:43:13 -0700 |
---|---|---|
committer | Raymond <siuchow@google.com> | 2015-04-02 10:43:13 -0700 |
commit | dee0849a9704d532af0b550146cbafbaa6ee1d19 (patch) | |
tree | 8ccce3a046c214fb609977b7fc53c40cef7f9ea5 /src/main/java/org/apache/commons/math/optimization/VectorialPointValuePair.java | |
parent | 55b0a5efc929efa9615babd3e760547f94e3518e (diff) | |
download | apache-commons-math-dee0849a9704d532af0b550146cbafbaa6ee1d19.tar.gz |
third party library: apache-commons-mathandroid-cts-6.0_r9android-cts-6.0_r8android-cts-6.0_r7android-cts-6.0_r6android-cts-6.0_r5android-cts-6.0_r4android-cts-6.0_r32android-cts-6.0_r31android-cts-6.0_r30android-cts-6.0_r3android-cts-6.0_r29android-cts-6.0_r28android-cts-6.0_r27android-cts-6.0_r26android-cts-6.0_r25android-cts-6.0_r24android-cts-6.0_r23android-cts-6.0_r22android-cts-6.0_r21android-cts-6.0_r20android-cts-6.0_r2android-cts-6.0_r19android-cts-6.0_r18android-cts-6.0_r17android-cts-6.0_r16android-cts-6.0_r15android-cts-6.0_r14android-cts-6.0_r13android-cts-6.0_r12android-cts-6.0_r1android-6.0.1_r9android-6.0.1_r81android-6.0.1_r80android-6.0.1_r8android-6.0.1_r79android-6.0.1_r78android-6.0.1_r77android-6.0.1_r74android-6.0.1_r73android-6.0.1_r72android-6.0.1_r70android-6.0.1_r7android-6.0.1_r69android-6.0.1_r68android-6.0.1_r67android-6.0.1_r66android-6.0.1_r65android-6.0.1_r63android-6.0.1_r62android-6.0.1_r61android-6.0.1_r60android-6.0.1_r59android-6.0.1_r58android-6.0.1_r57android-6.0.1_r56android-6.0.1_r55android-6.0.1_r54android-6.0.1_r53android-6.0.1_r52android-6.0.1_r51android-6.0.1_r50android-6.0.1_r5android-6.0.1_r49android-6.0.1_r48android-6.0.1_r47android-6.0.1_r46android-6.0.1_r45android-6.0.1_r43android-6.0.1_r42android-6.0.1_r41android-6.0.1_r40android-6.0.1_r4android-6.0.1_r33android-6.0.1_r32android-6.0.1_r31android-6.0.1_r30android-6.0.1_r3android-6.0.1_r28android-6.0.1_r27android-6.0.1_r26android-6.0.1_r25android-6.0.1_r24android-6.0.1_r22android-6.0.1_r21android-6.0.1_r20android-6.0.1_r18android-6.0.1_r17android-6.0.1_r16android-6.0.1_r13android-6.0.1_r12android-6.0.1_r11android-6.0.1_r10android-6.0.1_r1android-6.0.0_r7android-6.0.0_r6android-6.0.0_r5android-6.0.0_r41android-6.0.0_r4android-6.0.0_r3android-6.0.0_r26android-6.0.0_r25android-6.0.0_r24android-6.0.0_r23android-6.0.0_r2android-6.0.0_r13android-6.0.0_r12android-6.0.0_r11android-6.0.0_r1marshmallow-releasemarshmallow-mr3-releasemarshmallow-mr2-releasemarshmallow-mr1-releasemarshmallow-mr1-devmarshmallow-dr1.6-releasemarshmallow-dr1.5-releasemarshmallow-dr1.5-devmarshmallow-dr-releasemarshmallow-dr-dragon-releasemarshmallow-dr-devmarshmallow-devmarshmallow-cts-release
Change-Id: I52a325624a7f0dd652b362a9840626d6d9f3c42b
Diffstat (limited to 'src/main/java/org/apache/commons/math/optimization/VectorialPointValuePair.java')
-rw-r--r-- | src/main/java/org/apache/commons/math/optimization/VectorialPointValuePair.java | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/src/main/java/org/apache/commons/math/optimization/VectorialPointValuePair.java b/src/main/java/org/apache/commons/math/optimization/VectorialPointValuePair.java new file mode 100644 index 0000000..13f1134 --- /dev/null +++ b/src/main/java/org/apache/commons/math/optimization/VectorialPointValuePair.java @@ -0,0 +1,100 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.commons.math.optimization; + +import java.io.Serializable; + +/** + * This class holds a point and the vectorial value of an objective function at this point. + * <p>This is a simple immutable container.</p> + * @see RealPointValuePair + * @see org.apache.commons.math.analysis.MultivariateVectorialFunction + * @version $Revision: 980981 $ $Date: 2010-07-31 00:03:04 +0200 (sam. 31 juil. 2010) $ + * @since 2.0 + */ +public class VectorialPointValuePair implements Serializable { + + /** Serializable version identifier. */ + private static final long serialVersionUID = 1003888396256744753L; + + /** Point coordinates. */ + private final double[] point; + + /** Vectorial value of the objective function at the point. */ + private final double[] value; + + /** Build a point/objective function value pair. + * @param point point coordinates (the built instance will store + * a copy of the array, not the array passed as argument) + * @param value value of an objective function at the point + */ + public VectorialPointValuePair(final double[] point, final double[] value) { + this.point = (point == null) ? null : point.clone(); + this.value = (value == null) ? null : value.clone(); + } + + /** Build a point/objective function value pair. + * @param point point coordinates (the built instance will store + * a copy of the array, not the array passed as argument) + * @param value value of an objective function at the point + * @param copyArray if true, the input arrays will be copied, otherwise + * they will be referenced + */ + public VectorialPointValuePair(final double[] point, final double[] value, + final boolean copyArray) { + this.point = copyArray ? + ((point == null) ? null : point.clone()) : + point; + this.value = copyArray ? + ((value == null) ? null : value.clone()) : + value; + } + + /** Get the point. + * @return a copy of the stored point + */ + public double[] getPoint() { + return (point == null) ? null : point.clone(); + } + + /** Get a reference to the point. + * <p>This method is provided as a convenience to avoid copying + * the array, the elements of the array should <em>not</em> be modified.</p> + * @return a reference to the internal array storing the point + */ + public double[] getPointRef() { + return point; + } + + /** Get the value of the objective function. + * @return a copy of the stored value of the objective function + */ + public double[] getValue() { + return (value == null) ? null : value.clone(); + } + + /** Get a reference to the value of the objective function. + * <p>This method is provided as a convenience to avoid copying + * the array, the elements of the array should <em>not</em> be modified.</p> + * @return a reference to the internal array storing the value of the objective function + */ + public double[] getValueRef() { + return value; + } + +} |