001 /* 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache License, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the License for the specific language governing permissions and 015 * limitations under the License. 016 */ 017 018 package org.apache.commons.math.optimization; 019 020 import java.io.Serializable; 021 022 /** 023 * This class holds a point and the vectorial value of an objective function at this point. 024 * <p>This is a simple immutable container.</p> 025 * @see RealPointValuePair 026 * @see org.apache.commons.math.analysis.MultivariateVectorialFunction 027 * @version $Revision: 811685 $ $Date: 2009-09-05 13:36:48 -0400 (Sat, 05 Sep 2009) $ 028 * @since 2.0 029 */ 030 public class VectorialPointValuePair implements Serializable { 031 032 /** Serializable version identifier. */ 033 private static final long serialVersionUID = 1003888396256744753L; 034 035 /** Point coordinates. */ 036 private final double[] point; 037 038 /** Vectorial value of the objective function at the point. */ 039 private final double[] value; 040 041 /** Build a point/objective function value pair. 042 * @param point point coordinates (the built instance will store 043 * a copy of the array, not the array passed as argument) 044 * @param value value of an objective function at the point 045 */ 046 public VectorialPointValuePair(final double[] point, final double[] value) { 047 this.point = point.clone(); 048 this.value = value.clone(); 049 } 050 051 /** Build a point/objective function value pair. 052 * @param point point coordinates (the built instance will store 053 * a copy of the array, not the array passed as argument) 054 * @param value value of an objective function at the point 055 * @param copyArray if true, the input arrays will be copied, otherwise 056 * they will be referenced 057 */ 058 public VectorialPointValuePair(final double[] point, final double[] value, 059 final boolean copyArray) { 060 this.point = copyArray ? point.clone() : point; 061 this.value = copyArray ? value.clone() : value; 062 } 063 064 /** Get the point. 065 * @return a copy of the stored point 066 */ 067 public double[] getPoint() { 068 return point.clone(); 069 } 070 071 /** Get a reference to the point. 072 * <p>This method is provided as a convenience to avoid copying 073 * the array, the elements of the array should <em>not</em> be modified.</p> 074 * @return a reference to the internal array storing the point 075 */ 076 public double[] getPointRef() { 077 return point; 078 } 079 080 /** Get the value of the objective function. 081 * @return a copy of the stored value of the objective function 082 */ 083 public double[] getValue() { 084 return value.clone(); 085 } 086 087 /** Get a reference to the value of the objective function. 088 * <p>This method is provided as a convenience to avoid copying 089 * the array, the elements of the array should <em>not</em> be modified.</p> 090 * @return a reference to the internal array storing the value of the objective function 091 */ 092 public double[] getValueRef() { 093 return value; 094 } 095 096 }