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.math3.optimization; 019 020 import org.apache.commons.math3.linear.RealMatrix; 021 import org.apache.commons.math3.linear.Array2DRowRealMatrix; 022 import org.apache.commons.math3.linear.NonSquareMatrixException; 023 024 /** 025 * Weight matrix of the residuals between model and observations. 026 * <br/> 027 * Immutable class. 028 * 029 * @version $Id: Weight.java 1422230 2012-12-15 12:11:13Z erans $ 030 * @deprecated As of 3.1 (to be removed in 4.0). 031 * @since 3.1 032 */ 033 @Deprecated 034 public class Weight implements OptimizationData { 035 /** Weight matrix. */ 036 private final RealMatrix weightMatrix; 037 038 /** 039 * Creates a diagonal weight matrix. 040 * 041 * @param weight List of the values of the diagonal. 042 */ 043 public Weight(double[] weight) { 044 final int dim = weight.length; 045 weightMatrix = new Array2DRowRealMatrix(dim, dim); 046 for (int i = 0; i < dim; i++) { 047 weightMatrix.setEntry(i, i, weight[i]); 048 } 049 } 050 051 /** 052 * @param weight Weight matrix. 053 * @throws NonSquareMatrixException if the argument is not 054 * a square matrix. 055 */ 056 public Weight(RealMatrix weight) { 057 if (weight.getColumnDimension() != weight.getRowDimension()) { 058 throw new NonSquareMatrixException(weight.getColumnDimension(), 059 weight.getRowDimension()); 060 } 061 062 weightMatrix = weight.copy(); 063 } 064 065 /** 066 * Gets the initial guess. 067 * 068 * @return the initial guess. 069 */ 070 public RealMatrix getWeight() { 071 return weightMatrix.copy(); 072 } 073 }