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 */ 017package org.apache.commons.math4.legacy.optim.nonlinear.scalar; 018 019import org.apache.commons.math4.legacy.optim.OptimizationData; 020import org.apache.commons.math4.legacy.exception.NotStrictlyPositiveException; 021 022/** 023 * Input sigma values define the initial coordinate-wise extent for 024 * sampling the solution space around the initial guess. 025 */ 026public class Sigma implements OptimizationData { 027 /** Sigma values. */ 028 private final double[] sigma; 029 030 /** 031 * @param s Sigma values. 032 * @throws NotStrictlyPositiveException if any of the array 033 * entries is negative. 034 */ 035 public Sigma(double[] s) { 036 for (int i = 0; i < s.length; i++) { 037 if (s[i] <= 0) { 038 throw new NotStrictlyPositiveException(s[i]); 039 } 040 } 041 042 sigma = s.clone(); 043 } 044 045 /** 046 * @return the sigma values. 047 */ 048 public double[] getSigma() { 049 return sigma.clone(); 050 } 051}