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 package org.apache.commons.math4.legacy.optim.nonlinear.scalar;
18
19 import org.apache.commons.math4.legacy.optim.OptimizationData;
20 import org.apache.commons.math4.legacy.exception.NotStrictlyPositiveException;
21
22 /**
23 * Input sigma values define the initial coordinate-wise extent for
24 * sampling the solution space around the initial guess.
25 */
26 public class Sigma implements OptimizationData {
27 /** Sigma values. */
28 private final double[] sigma;
29
30 /**
31 * @param s Sigma values.
32 * @throws NotStrictlyPositiveException if any of the array
33 * entries is negative.
34 */
35 public Sigma(double[] s) {
36 for (int i = 0; i < s.length; i++) {
37 if (s[i] <= 0) {
38 throw new NotStrictlyPositiveException(s[i]);
39 }
40 }
41
42 sigma = s.clone();
43 }
44
45 /**
46 * @return the sigma values.
47 */
48 public double[] getSigma() {
49 return sigma.clone();
50 }
51 }