|
Commons Math example source code file (BigMatrix.java)
The Commons Math BigMatrix.java source code/* * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright ownership. * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package org.apache.commons.math.linear; import java.math.BigDecimal; /** * Interface defining a real-valued matrix with basic algebraic operations, using * BigDecimal representations for the entries. * <p> * Matrix element indexing is 0-based -- e.g., <code>getEntry(0, 0) * returns the element in the first row, first column of the matrix.</p> * * @version $Revision: 811786 $ $Date: 2009-09-06 05:36:08 -0400 (Sun, 06 Sep 2009) $ * @deprecated as of 2.0, replaced by {@link FieldMatrix} with a {@link * org.apache.commons.math.util.BigReal} parameter */ @Deprecated public interface BigMatrix extends AnyMatrix { /** * Returns a (deep) copy of this. * * @return matrix copy */ BigMatrix copy(); /** * Compute the sum of this and m. * * @param m matrix to be added * @return this + m * @exception IllegalArgumentException if m is not the same size as this */ BigMatrix add(BigMatrix m) throws IllegalArgumentException; /** * Compute this minus m. * * @param m matrix to be subtracted * @return this + m * @exception IllegalArgumentException if m is not the same size as this */ BigMatrix subtract(BigMatrix m) throws IllegalArgumentException; /** * Returns the result of adding d to each entry of this. * * @param d value to be added to each entry * @return d + this */ BigMatrix scalarAdd(BigDecimal d); /** * Returns the result multiplying each entry of this by d. * * @param d value to multiply all entries by * @return d * this */ BigMatrix scalarMultiply(BigDecimal d); /** * Returns the result of postmultiplying this by m. * * @param m matrix to postmultiply by * @return this * m * @throws IllegalArgumentException * if columnDimension(this) != rowDimension(m) */ BigMatrix multiply(BigMatrix m) throws IllegalArgumentException; /** * Returns the result premultiplying this by <code>m. * @param m matrix to premultiply by * @return m * this * @throws IllegalArgumentException * if rowDimension(this) != columnDimension(m) */ BigMatrix preMultiply(BigMatrix m) throws IllegalArgumentException; /** * Returns matrix entries as a two-dimensional array. * * @return 2-dimensional array of entries */ BigDecimal[][] getData(); /** * Returns matrix entries as a two-dimensional array. * * @return 2-dimensional array of entries */ double [][] getDataAsDoubleArray(); /*** * Gets the rounding mode * @return the rounding mode */ int getRoundingMode(); /** * Returns the <a href="http://mathworld.wolfram.com/MaximumAbsoluteRowSumNorm.html"> * maximum absolute row sum norm</a> of the matrix. * * @return norm */ BigDecimal getNorm(); /** * Gets a submatrix. Rows and columns are indicated * counting from 0 to n-1. * * @param startRow Initial row index * @param endRow Final row index * @param startColumn Initial column index * @param endColumn Final column index * @return The subMatrix containing the data of the * specified rows and columns * @exception MatrixIndexException if the indices are not valid */ BigMatrix getSubMatrix(int startRow, int endRow, int startColumn, int endColumn) throws MatrixIndexException; /** * Gets a submatrix. Rows and columns are indicated * counting from 0 to n-1. * * @param selectedRows Array of row indices. * @param selectedColumns Array of column indices. * @return The subMatrix containing the data in the * specified rows and columns * @exception MatrixIndexException if row or column selections are not valid */ BigMatrix getSubMatrix(int[] selectedRows, int[] selectedColumns) throws MatrixIndexException; /** * Returns the entries in row number <code>row * as a row matrix. Row indices start at 0. * * @param row the row to be fetched * @return row matrix * @throws MatrixIndexException if the specified row index is invalid */ BigMatrix getRowMatrix(int row) throws MatrixIndexException; /** * Returns the entries in column number <code>column * as a column matrix. Column indices start at 0. * * @param column the column to be fetched * @return column matrix * @throws MatrixIndexException if the specified column index is invalid */ BigMatrix getColumnMatrix(int column) throws MatrixIndexException; /** * Returns the entries in row number <code>row as an array. * <p> * Row indices start at 0. A <code>MatrixIndexException is thrown * unless <code>0 <= row < rowDimension. * * @param row the row to be fetched * @return array of entries in the row * @throws MatrixIndexException if the specified row index is not valid */ BigDecimal[] getRow(int row) throws MatrixIndexException; /** * Returns the entries in row number <code>row as an array * of double values. * <p> * Row indices start at 0. A <code>MatrixIndexException is thrown * unless <code>0 <= row < rowDimension. * * @param row the row to be fetched * @return array of entries in the row * @throws MatrixIndexException if the specified row index is not valid */ double [] getRowAsDoubleArray(int row) throws MatrixIndexException; /** * Returns the entries in column number <code>col as an array. * <p> * Column indices start at 0. A <code>MatrixIndexException is thrown * unless <code>0 <= column < columnDimension. * * @param col the column to be fetched * @return array of entries in the column * @throws MatrixIndexException if the specified column index is not valid */ BigDecimal[] getColumn(int col) throws MatrixIndexException; /** * Returns the entries in column number <code>col as an array * of double values. * <p> * Column indices start at 0. A <code>MatrixIndexException is thrown * unless <code>0 <= column < columnDimension. * * @param col the column to be fetched * @return array of entries in the column * @throws MatrixIndexException if the specified column index is not valid */ double [] getColumnAsDoubleArray(int col) throws MatrixIndexException; /** * Returns the entry in the specified row and column. * <p> * Row and column indices start at 0 and must satisfy * <ul> * <li> Other Commons Math examples (source code examples)Here is a short list of links related to this Commons Math BigMatrix.java source code file: |
... this post is sponsored by my books ... | |
#1 New Release! |
FP Best Seller |
Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.
A percentage of advertising revenue from
pages under the /java/jwarehouse
URI on this website is
paid back to open source projects.