Java Doc for RealMatrix.java in  » Science » Apache-commons-math-1.1 » org » apache » commons » math » linear » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Science » Apache commons math 1.1 » org.apache.commons.math.linear 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.commons.math.linear.RealMatrix

All known Subclasses:   org.apache.commons.math.linear.RealMatrixImpl,
RealMatrix
public interface RealMatrix (Code)
Interface defining a real-valued matrix with basic algebraic operations.

Matrix element indexing is 0-based -- e.g., getEntry(0, 0) returns the element in the first row, first column of the matrix.
version:
   $Revision: 208875 $ $Date: 2005-07-02 15:38:00 -0700 (Sat, 02 Jul 2005) $





Method Summary
 RealMatrixadd(RealMatrix m)
     Compute the sum of this and m.
 RealMatrixcopy()
     Returns a (deep) copy of this.
 double[]getColumn(int col)
     Returns the entries in column number col as an array.

Column indices start at 0.

 intgetColumnDimension()
     Returns the number of columns in the matrix.
 RealMatrixgetColumnMatrix(int column)
     Returns the entries in column number column as a column matrix.
 double[][]getData()
     Returns matrix entries as a two-dimensional array.
 doublegetDeterminant()
     Returns the determinant of this matrix.
 doublegetEntry(int row, int column)
     Returns the entry in the specified row and column.
 doublegetNorm()
     Returns the maximum absolute row sum norm of the matrix.
 double[]getRow(int row)
     Returns the entries in row number row as an array.

Row indices start at 0.

 intgetRowDimension()
     Returns the number of rows in the matrix.
 RealMatrixgetRowMatrix(int row)
     Returns the entries in row number row as a row matrix.
 RealMatrixgetSubMatrix(int startRow, int endRow, int startColumn, int endColumn)
     Gets a submatrix.
 RealMatrixgetSubMatrix(int[] selectedRows, int[] selectedColumns)
     Gets a submatrix.
 doublegetTrace()
     Returns the trace of the matrix (the sum of the elements on the main diagonal).
 RealMatrixinverse()
     Returns the inverse of this matrix.
 booleanisSingular()
    
 booleanisSquare()
    
 RealMatrixmultiply(RealMatrix m)
     Returns the result of postmultiplying this by m.
 double[]operate(double[] v)
     Returns the result of multiplying this by the vector v.
public  RealMatrixpreMultiply(RealMatrix m)
     Returns the result premultiplying this by m.
 double[]preMultiply(double[] v)
     Returns the (row) vector result of premultiplying this by the vector v.
 RealMatrixscalarAdd(double d)
     Returns the result of adding d to each entry of this.
 RealMatrixscalarMultiply(double d)
     Returns the result multiplying each entry of this by d.
 double[]solve(double[] b)
     Returns the solution vector for a linear system with coefficient matrix = this and constant vector = b.
 RealMatrixsolve(RealMatrix b)
     Returns a matrix of (column) solution vectors for linear systems with coefficient matrix = this and constant vectors = columns of b.
 RealMatrixsubtract(RealMatrix m)
     Compute this minus m.
 RealMatrixtranspose()
     Returns the transpose of this matrix.



Method Detail
add
RealMatrix add(RealMatrix m) throws IllegalArgumentException(Code)
Compute the sum of this and m.
Parameters:
  m - matrix to be added this + m
throws:
  IllegalArgumentException - if m is not the same size as this



copy
RealMatrix copy()(Code)
Returns a (deep) copy of this. matrix copy



getColumn
double[] getColumn(int col) throws MatrixIndexException(Code)
Returns the entries in column number col as an array.

Column indices start at 0. A MatrixIndexException is thrown unless 0 <= column < columnDimension.
Parameters:
  col - the column to be fetched array of entries in the column
throws:
  MatrixIndexException - if the specified column index is not valid




getColumnDimension
int getColumnDimension()(Code)
Returns the number of columns in the matrix. columnDimension



getColumnMatrix
RealMatrix getColumnMatrix(int column) throws MatrixIndexException(Code)
Returns the entries in column number column as a column matrix. Column indices start at 0.
Parameters:
  column - the column to be fetched column matrix
throws:
  MatrixIndexException - if the specified column index is invalid



getData
double[][] getData()(Code)
Returns matrix entries as a two-dimensional array. 2-dimensional array of entries



getDeterminant
double getDeterminant()(Code)
Returns the determinant of this matrix. determinant



getEntry
double getEntry(int row, int column) throws MatrixIndexException(Code)
Returns the entry in the specified row and column.

Row and column indices start at 0 and must satisfy

  • 0 <= row < rowDimension
  • 0 <= column < columnDimension
otherwise a MatrixIndexException is thrown.
Parameters:
  row - row location of entry to be fetched
Parameters:
  column - column location of entry to be fetched matrix entry in row,column
throws:
  MatrixIndexException - if the row or column index is not valid



getNorm
double getNorm()(Code)
Returns the maximum absolute row sum norm of the matrix. norm



getRow
double[] getRow(int row) throws MatrixIndexException(Code)
Returns the entries in row number row as an array.

Row indices start at 0. A MatrixIndexException is thrown unless 0 <= row < rowDimension.
Parameters:
  row - the row to be fetched array of entries in the row
throws:
  MatrixIndexException - if the specified row index is not valid




getRowDimension
int getRowDimension()(Code)
Returns the number of rows in the matrix. rowDimension



getRowMatrix
RealMatrix getRowMatrix(int row) throws MatrixIndexException(Code)
Returns the entries in row number row as a row matrix. Row indices start at 0.
Parameters:
  row - the row to be fetched row matrix
throws:
  MatrixIndexException - if the specified row index is invalid



getSubMatrix
RealMatrix getSubMatrix(int startRow, int endRow, int startColumn, int endColumn) throws MatrixIndexException(Code)
Gets a submatrix. Rows and columns are indicated counting from 0 to n-1.
Parameters:
  startRow - Initial row index
Parameters:
  endRow - Final row index
Parameters:
  startColumn - Initial column index
Parameters:
  endColumn - Final column index The subMatrix containing the data of thespecified rows and columns
exception:
  MatrixIndexException - if the indices are not valid



getSubMatrix
RealMatrix getSubMatrix(int[] selectedRows, int[] selectedColumns) throws MatrixIndexException(Code)
Gets a submatrix. Rows and columns are indicated counting from 0 to n-1.
Parameters:
  selectedRows - Array of row indices.
Parameters:
  selectedColumns - Array of column indices. The subMatrix containing the data in thespecified rows and columns
exception:
  MatrixIndexException - if row or column selections are not valid



getTrace
double getTrace()(Code)
Returns the trace of the matrix (the sum of the elements on the main diagonal). trace



inverse
RealMatrix inverse() throws InvalidMatrixException(Code)
Returns the inverse of this matrix. inverse matrix
throws:
  InvalidMatrixException - if this is not invertible



isSingular
boolean isSingular()(Code)
Is this a singular matrix? true if the matrix is singular



isSquare
boolean isSquare()(Code)
Is this a square matrix? true if the matrix is square (rowDimension = columnDimension)



multiply
RealMatrix multiply(RealMatrix m) throws IllegalArgumentException(Code)
Returns the result of postmultiplying this by m.
Parameters:
  m - matrix to postmultiply by this * m
throws:
  IllegalArgumentException - if columnDimension(this) != rowDimension(m)



operate
double[] operate(double[] v) throws IllegalArgumentException(Code)
Returns the result of multiplying this by the vector v.
Parameters:
  v - the vector to operate on this*v
throws:
  IllegalArgumentException - if columnDimension != v.size()



preMultiply
public RealMatrix preMultiply(RealMatrix m) throws IllegalArgumentException(Code)
Returns the result premultiplying this by m.
Parameters:
  m - matrix to premultiply by m * this
throws:
  IllegalArgumentException - if rowDimension(this) != columnDimension(m)



preMultiply
double[] preMultiply(double[] v) throws IllegalArgumentException(Code)
Returns the (row) vector result of premultiplying this by the vector v.
Parameters:
  v - the row vector to premultiply by v*this
throws:
  IllegalArgumentException - if rowDimension != v.size()



scalarAdd
RealMatrix scalarAdd(double d)(Code)
Returns the result of adding d to each entry of this.
Parameters:
  d - value to be added to each entry d + this



scalarMultiply
RealMatrix scalarMultiply(double d)(Code)
Returns the result multiplying each entry of this by d.
Parameters:
  d - value to multiply all entries by d * this



solve
double[] solve(double[] b) throws IllegalArgumentException, InvalidMatrixException(Code)
Returns the solution vector for a linear system with coefficient matrix = this and constant vector = b.
Parameters:
  b - constant vector vector of solution values to AX = b, where A is *this
throws:
  IllegalArgumentException - if this.rowDimension != b.length
throws:
  InvalidMatrixException - if this matrix is not square or is singular



solve
RealMatrix solve(RealMatrix b) throws IllegalArgumentException, InvalidMatrixException(Code)
Returns a matrix of (column) solution vectors for linear systems with coefficient matrix = this and constant vectors = columns of b.
Parameters:
  b - matrix of constant vectors forming RHS of linear systems toto solve matrix of solution vectors
throws:
  IllegalArgumentException - if this.rowDimension != row dimension
throws:
  InvalidMatrixException - if this matrix is not square or is singular



subtract
RealMatrix subtract(RealMatrix m) throws IllegalArgumentException(Code)
Compute this minus m.
Parameters:
  m - matrix to be subtracted this + m
throws:
  IllegalArgumentException - if m is not the same size as this



transpose
RealMatrix transpose()(Code)
Returns the transpose of this matrix. transpose matrix



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.