1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.commons.math.optimization;
19
20 /**
21 * This class holds a point and its associated cost.
22 * <p>This is a simple immutable container.</p>
23 * @version $Revision: 620312 $ $Date: 2008-02-10 12:28:59 -0700 (Sun, 10 Feb 2008) $
24 * @see CostFunction
25 * @since 1.2
26 */
27 public class PointCostPair {
28
29 /** Build a point/cost pair.
30 * @param point point coordinates (the built instance will store
31 * a copy of the array, not the array passed as argument)
32 * @param cost point cost
33 */
34 public PointCostPair(double[] point, double cost) {
35 this.point = (double[]) point.clone();
36 this.cost = cost;
37 }
38
39 /** Get the point.
40 * @return a copy of the stored point
41 */
42 public double[] getPoint() {
43 return (double[]) point.clone();
44 }
45
46 /** Get the cost.
47 * @return the stored cost
48 */
49 public double getCost() {
50 return cost;
51 }
52
53 /** Point coordinates. */
54 private final double[] point;
55
56 /** Cost associated to the point. */
57 private final double cost;
58
59 }