annotate mayachemtools/docs/modules/html/Matrix.html @ 9:ab29fa5c8c1f draft default tip

Uploaded
author deepakjadmin
date Thu, 15 Dec 2016 14:18:03 -0500
parents 73ae111cf86f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
1 <html>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
2 <head>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
3 <title>MayaChemTools:Documentation:Matrix.pm</title>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
4 <meta http-equiv="content-type" content="text/html;charset=utf-8">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
5 <link rel="stylesheet" type="text/css" href="../../css/MayaChemTools.css">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
6 </head>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
7 <body leftmargin="20" rightmargin="20" topmargin="10" bottommargin="10">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
8 <br/>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
9 <center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
10 <a href="http://www.mayachemtools.org" title="MayaChemTools Home"><img src="../../images/MayaChemToolsLogo.gif" border="0" alt="MayaChemTools"></a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
11 </center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
12 <br/>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
13 <div class="DocNav">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
14 <table width="100%" border=0 cellpadding=0 cellspacing=2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
15 <tr align="left" valign="top"><td width="33%" align="left"><a href="./MathUtil.html" title="MathUtil.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./AtomsCountDescriptors.html" title="AtomsCountDescriptors.html">Next</a></td><td width="34%" align="middle"><strong>Matrix.pm</strong></td><td width="33%" align="right"><a href="././code/Matrix.html" title="View source code">Code</a>&nbsp;|&nbsp;<a href="./../pdf/Matrix.pdf" title="PDF US Letter Size">PDF</a>&nbsp;|&nbsp;<a href="./../pdfgreen/Matrix.pdf" title="PDF US Letter Size with narrow margins: www.changethemargins.com">PDFGreen</a>&nbsp;|&nbsp;<a href="./../pdfa4/Matrix.pdf" title="PDF A4 Size">PDFA4</a>&nbsp;|&nbsp;<a href="./../pdfa4green/Matrix.pdf" title="PDF A4 Size with narrow margins: www.changethemargins.com">PDFA4Green</a></td></tr>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
16 </table>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
17 </div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
18 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
19 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
20 <h2>NAME</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
21 <p>Matrix</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
22 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
23 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
24 <h2>SYNOPSIS</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
25 <p>use Matrix;</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
26 <p>use Matrix qw(:all);</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
27 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
28 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
29 <h2>DESCRIPTION</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
30 <p><strong>Matrix</strong> class provides the following methods:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
31 <p> <a href="#new">new</a>, <a href="#addcolumnvalues">AddColumnValues</a>, <a href="#addrowvalues">AddRowValues</a>, <a href="#copy">Copy</a>, <a href="#getcolumnvalues">GetColumnValues</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
32 , <a href="#getcolumnvaluesascolumnmatrix">GetColumnValuesAsColumnMatrix</a>, <a href="#getcolumnvaluesasrowmatrix">GetColumnValuesAsRowMatrix</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
33 , <a href="#getcolumnvaluesasstring">GetColumnValuesAsString</a>, <a href="#getcolumnvaluesasvector">GetColumnValuesAsVector</a>, <a href="#getdiagonalvalues">GetDiagonalValues</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
34 , <a href="#getdiagonalvaluesascolumnmatrix">GetDiagonalValuesAsColumnMatrix</a>, <a href="#getdiagonalvaluesasrowmatrix">GetDiagonalValuesAsRowMatrix</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
35 , <a href="#getdiagonalvaluesasstring">GetDiagonalValuesAsString</a>, <a href="#getdiagonalvaluesasvector">GetDiagonalValuesAsVector</a>, <a href="#getdimension">GetDimension</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
36 , <a href="#getmatrixvaluesreference">GetMatrixValuesReference</a>, <a href="#getnumofcolumns">GetNumOfColumns</a>, <a href="#getnumofrows">GetNumOfRows</a>, <a href="#getrowvalues">GetRowValues</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
37 , <a href="#getrowvaluesascolumnmatrix">GetRowValuesAsColumnMatrix</a>, <a href="#getrowvaluesasrowmatrix">GetRowValuesAsRowMatrix</a>, <a href="#getrowvaluesasstring">GetRowValuesAsString</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
38 , <a href="#getrowvaluesasvector">GetRowValuesAsVector</a>, <a href="#getsize">GetSize</a>, <a href="#getvalue">GetValue</a>, <a href="#identitymatrix">IdentityMatrix</a>, <a href="#isantisymmetric">IsAntiSymmetric</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
39 , <a href="#isbidiagonal">IsBiDiagonal</a>, <a href="#isdiagonal">IsDiagonal</a>, <a href="#isidentity">IsIdentity</a>, <a href="#islefttriangular">IsLeftTriangular</a>, <a href="#islowerbidiagonal">IsLowerBiDiagonal</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
40 , <a href="#islowertriangular">IsLowerTriangular</a>, <a href="#islowerunitriangular">IsLowerUniTriangular</a>, <a href="#ismatrix">IsMatrix</a>, <a href="#isnegative">IsNegative</a>, <a href="#ispositive">IsPositive</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
41 , <a href="#isrighttriangular">IsRightTriangular</a>, <a href="#isskewsymmetric">IsSkewSymmetric</a>, <a href="#issquare">IsSquare</a>, <a href="#isstrictlylowertriangular">IsStrictlyLowerTriangular</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
42 , <a href="#isstrictlyuppertriangular">IsStrictlyUpperTriangular</a>, <a href="#issymmetric">IsSymmetric</a>, <a href="#istridiagonal">IsTriDiagonal</a>, <a href="#isunit">IsUnit</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
43 , <a href="#isunitlowertriangular">IsUnitLowerTriangular</a>, <a href="#isunituppertriangular">IsUnitUpperTriangular</a>, <a href="#isupperbidiagonal">IsUpperBiDiagonal</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
44 , <a href="#isuppertriangular">IsUpperTriangular</a>, <a href="#isupperunitriangular">IsUpperUniTriangular</a>, <a href="#newfromcolumns">NewFromColumns</a>, <a href="#newfromdiagonal">NewFromDiagonal</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
45 , <a href="#newfromrows">NewFromRows</a>, <a href="#one">One</a>, <a href="#setallvalues">SetAllValues</a>, <a href="#setcolumnvalues">SetColumnValues</a>, <a href="#setdiagonalvalues">SetDiagonalValues</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
46 , <a href="#setmatrixprintstyle">SetMatrixPrintStyle</a>, <a href="#setrowvalues">SetRowValues</a>, <a href="#setvalue">SetValue</a>, <a href="#setvalueprintformat">SetValuePrintFormat</a>, <a href="#stringifymatrix">StringifyMatrix</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
47 , <a href="#transpose">Transpose</a>, <a href="#unitmatrix">UnitMatrix</a>, <a href="#zero">Zero</a>, <a href="#zeromatrix">ZeroMatrix</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
48 </p><p>The following functions are available:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
49 <p>IsMatrix, IdentityMatrix, NewFromRows, NewFromColumns, NewFromDiagonal,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
50 UnitMatrix, ZeroMatrix</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
51 <p>The following operators are overloaded:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
52 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
53 &quot;&quot; bool !
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
54 <br/> @{}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
55 <br/> + - * / ** %
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
56 <br/> == != &lt; &lt;= &gt; &gt;=
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
57 <br/> neg
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
58 <br/> abs exp log sqrt cos sin</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
59 <p>The matrix row and column indicies start from zero.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
60 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
61 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
62 <h2>FUNCTIONS</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
63 <dl>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
64 <dt><strong><a name="new" class="item"><strong>new</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
65 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
66 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
67 $NewMatrix = $Matrix-&gt;new($NumOfRows, $NumOfCols);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
68 <p>Creates a new <strong>Matrix</strong> of size <em>NumOfRows x NumOfCol</em> and returns <strong>NewMatrix</strong>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
69 object.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
70 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
71 <dt><strong><a name="addcolumnvalues" class="item"><strong>AddColumnValues</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
72 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
73 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
74 $Matrix-&gt;AddColumnValues(@Values);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
75 <br/> $Matrix-&gt;AddColumnValues(\@Values);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
76 <br/> $Matrix-&gt;AddColumnValues($VectorObject);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
77 <br/> $Matrix-&gt;AddColumnValues(&quot;Value1 Value2 Value3 ...&quot;);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
78 <p>Adds column values to <em>Matrix</em> using an array, reference to an array, another vector, or space
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
79 delimited value string and returns <em>Matrix</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
80 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
81 <dt><strong><a name="addrowvalues" class="item"><strong>AddRowValues</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
82 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
83 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
84 $Matrix-&gt;AddRowValues(@Values);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
85 <br/> $Matrix-&gt;AddRowValues(\@Values);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
86 <br/> $Matrix-&gt;AddRowValues($VectorObject);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
87 <br/> $Matrix-&gt;AddRowValues(&quot;Value1 Value2 Value3 ...&quot;);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
88 <p>Adds row values to <em>Matrix</em> using an array, reference to an array, another vector, or space
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
89 delimited value string and returns <strong>Matrix</strong>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
90 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
91 <dt><strong><a name="copy" class="item"><strong>Copy</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
92 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
93 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
94 $NewMatrix = $Matrix-&gt;Copy();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
95 <p>Creates a copy of <em>Matrix</em> and returns <strong>NewMatrix</strong>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
96 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
97 <dt><strong><a name="getcolumnvalues" class="item"><strong>GetColumnValues</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
98 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
99 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
100 @Values = $Matrix-&gt;GetColumnValues($ColIndex);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
101 <br/> $ValueCount = $Matrix-&gt;GetColumnValues($ColIndex);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
102 <p>Returns an array containing column value specified using <em>ColIndex</em> with column index
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
103 starting at 0. In scalar context, number of column values is returned.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
104 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
105 <dt><strong><a name="getcolumnvaluesascolumnmatrix" class="item"><strong>GetColumnValuesAsColumnMatrix</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
106 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
107 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
108 $ColumnMatrix = $Matrix-&gt;GetColumnValuesAsColumnMatrix($ColIndex);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
109 <p>Returns a new <strong>ColumnMatrix</strong> containing column values specified using <em>ColIndex</em> with
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
110 column index starting at 0.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
111 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
112 <dt><strong><a name="getcolumnvaluesasrowmatrix" class="item"><strong>GetColumnValuesAsRowMatrix</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
113 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
114 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
115 $RowMatrix = $Matrix-&gt;GetColumnValuesAsRowMatrix($ColIndex);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
116 <p>Returns a new <strong>RowMatrix</strong> containing column values specified using <em>ColIndex</em> with
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
117 column index starting at 0.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
118 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
119 <dt><strong><a name="getcolumnvaluesasstring" class="item"><strong>GetColumnValuesAsString</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
120 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
121 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
122 $ColumnValuesString = $Matrix-&gt;GetColumnValuesAsString($ColIndex);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
123 <p>Returns a space delimited <strong>ColumnValuesString</strong> column values specified using <em>ColIndex</em> with
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
124 column index starting at 0.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
125 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
126 <dt><strong><a name="getcolumnvaluesasvector" class="item"><strong>GetColumnValuesAsVector</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
127 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
128 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
129 $ColumnVector = $Matrix-&gt;GetColumnValuesAsVector($ColIndex);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
130 <p>Returns a new <strong>ColumnVector</strong> column values specified using <em>RowIndex</em> with
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
131 column index starting at 0.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
132 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
133 <dt><strong><a name="getdiagonalvalues" class="item"><strong>GetDiagonalValues</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
134 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
135 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
136 @Values = $Matrix-&gt;GetDiagonalValues();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
137 <br/> $ValueCount = $Matrix-&gt;GetDiagonalValues();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
138 <p>Returns an array containing diagonal values. In scalar context, number of diagonal
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
139 values is returned.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
140 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
141 <dt><strong><a name="getdiagonalvaluesascolumnmatrix" class="item"><strong>GetDiagonalValuesAsColumnMatrix</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
142 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
143 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
144 $ColumnMatrix = $Matrix-&gt;GetDiagonalValuesAsColumnMatrix();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
145 <p>Returns a new <strong>ColumnMatrix</strong> containing diagonal values corresponding to <em>Matrix</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
146 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
147 <dt><strong><a name="getdiagonalvaluesasrowmatrix" class="item"><strong>GetDiagonalValuesAsRowMatrix</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
148 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
149 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
150 $RowMatrix = $Matrix-&gt;GetDiagonalValuesAsRowMatrix();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
151 <p>Returns a new <strong>RowMatrix</strong> containing diagonal values corresponding to <em>Matrix</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
152 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
153 <dt><strong><a name="getdiagonalvaluesasstring" class="item"><strong>GetDiagonalValuesAsString</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
154 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
155 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
156 $DiagonalValuesString = $Matrix-&gt;GetDiagonalValuesAsString();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
157 <p>Returns a space delimited <strong>DiagonalValuesString</strong> containing diagonal values corresponding to
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
158 <em>Matrix</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
159 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
160 <dt><strong><a name="getdiagonalvaluesasvector" class="item"><strong>GetDiagonalValuesAsVector</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
161 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
162 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
163 $DiagonalVector = $Matrix-&gt;GetDiagonalValuesAsVector();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
164 <p>Returns a new <strong>DiagonalVector</strong> containing diagonal values corresponding to <em>Matrix</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
165 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
166 <dt><strong><a name="getdimension" class="item"><strong>GetDimension</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
167 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
168 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
169 ($NumOfRows, $NumOfCols) = $Matrix-&gt;GetDimension();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
170 <p>Returns size of <em>Matrix</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
171 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
172 <dt><strong><a name="getmatrixvaluesreference" class="item"><strong>GetMatrixValuesReference</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
173 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
174 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
175 $ValuesRef = $Matrix-&gt;GetMatrixValuesReference();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
176 <p>Returns a reference to array containing rows and column values corresponding to <em>Matrix</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
177 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
178 <dt><strong><a name="getnumofcolumns" class="item"><strong>GetNumOfColumns</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
179 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
180 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
181 $NumOfCols = $Matrix-&gt;GetNumOfColumns();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
182 <p>Returns <strong>NumOfCols</strong> in <em>Matrix</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
183 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
184 <dt><strong><a name="getnumofrows" class="item"><strong>GetNumOfRows</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
185 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
186 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
187 $NumOfRows = $Matrix-&gt;GetNumOfRows();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
188 <p>Returns <strong>NumOfRows</strong> in <em>Matrix</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
189 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
190 <dt><strong><a name="getrowvalues" class="item"><strong>GetRowValues</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
191 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
192 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
193 @Values = $Matrix-&gt;GetRowValues($RowIndex);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
194 <br/> $ValueCount = $Matrix-&gt;GetRowValues($RowIndex);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
195 <p>Returns an array containing row value specified using <em>RowIndex</em> with row index
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
196 starting at 0. In scalar context, number of row values is returned.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
197 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
198 <dt><strong><a name="getrowvaluesascolumnmatrix" class="item"><strong>GetRowValuesAsColumnMatrix</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
199 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
200 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
201 $ColumnMatrix = $Matrix-&gt;GetRowValuesAsColumnMatrix($RowIndex);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
202 <p>Returns a new <strong>ColumnMatrix</strong> containing row values specified using <em>RowIndex</em> with
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
203 column index starting at 0.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
204 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
205 <dt><strong><a name="getrowvaluesasrowmatrix" class="item"><strong>GetRowValuesAsRowMatrix</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
206 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
207 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
208 $RowMatrix = $Matrix-&gt;GetRowValuesAsRowMatrix($RowIndex);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
209 <p>Returns a new <strong>RowMatrix</strong> containing row values specified using <em>RowIndex</em> with
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
210 row index starting at 0.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
211 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
212 <dt><strong><a name="getrowvaluesasstring" class="item"><strong>GetRowValuesAsString</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
213 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
214 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
215 $RowValuesString = $Matrix-&gt;GetRowValuesAsString($RowIndex);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
216 <p>Returns a space delimited <strong>RowValuesString</strong> row values specified using <em>RowIndex</em> with
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
217 row index starting at 0.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
218 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
219 <dt><strong><a name="getrowvaluesasvector" class="item"><strong>GetRowValuesAsVector</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
220 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
221 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
222 $RowVector = $Matrix-&gt;GetColumnValuesAsVector($RowIndex);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
223 <p>Returns a new <strong>RowVector</strong> row values specified using <em>RowIndex</em> with
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
224 row index starting at 0.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
225 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
226 <dt><strong><a name="getsize" class="item"><strong>GetSize</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
227 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
228 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
229 ($NumOfRows, $NumOfCols) = $Matrix-&gt;GetSize();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
230 <p>Returns size of <em>Matrix</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
231 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
232 <dt><strong><a name="getvalue" class="item"><strong>GetValue</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
233 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
234 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
235 $Value = $Matrix-&gt;GetValue($RowIndex, $ColIndex, [$SkipIndexCheck]);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
236 <p>Returns <strong>Value</strong> of <em>Matrix</em> element specified using <em>RowIndex</em> and <em>ColIndex</em> with indicies
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
237 starting at 0 with optional validation of specified index values.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
238 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
239 <dt><strong><a name="identitymatrix" class="item"><strong>IdentityMatrix</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
240 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
241 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
242 $NewIdentityMatrix = $Matrix-&gt;IdentityMatrix($NumOfRows, $NumOfCols);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
243 <br/> $NewIdentityMatrix = Matrix::IdentityMatrix($NumOfRows, $NumOfCols);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
244 <br/> $NewIdentityMatrix = Matrix::IdentityMatrix();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
245 <p>Creates a new <strong>IdentityMatrix</strong> of specified size <em>NumOfRows x NumOfCol</em> or of size 3 x 3 and
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
246 returns <strong>NewIdentityMatrix</strong> object.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
247 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
248 <dt><strong><a name="isantisymmetric" class="item"><strong>IsAntiSymmetric</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
249 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
250 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
251 $Status = $Matrix-&gt;IsAntiSymmetric();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
252 <p>Returns 1 or 0 based on whether <em>Matrix</em> is an anti symmetric matrix.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
253 <p>A matrix is an anti symmetric matrix:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
254 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
255 . It's a square matrix
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
256 <br/> . Its elements are asymmetric with respect to main diagonal. In other words,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
257 elements below the main diagonal are equal to the negative of elements above
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
258 the main diagonal.</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
259 <p>Transpose of an anti symmetric matrix equals the negative of the matrix.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
260 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
261 <dt><strong><a name="isbidiagonal" class="item"><strong>IsBiDiagonal</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
262 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
263 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
264 $Status = $Matrix-&gt;IsBiDiagonal();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
265 <p>Returns 1 or 0 based on whether <em>Matrix</em> is upper or lower bidiagonal matrix.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
266 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
267 <dt><strong><a name="isdiagonal" class="item"><strong>IsDiagonal</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
268 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
269 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
270 $Status = $Matrix-&gt;IsDiagonal();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
271 <p>Returns 1 or 0 based on whether <em>Matrix</em> is a diagonal matrix.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
272 <p>A matrix is a diagonal matrix:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
273 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
274 . It's a square matrix
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
275 <br/> . All its off-diagonal elements are zeros and its diagonal elements may or may not
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
276 be zeros</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
277 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
278 <dt><strong><a name="isidentity" class="item"><strong>IsIdentity</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
279 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
280 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
281 $Status = $Matrix-&gt;IsIdentity();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
282 <p>Returns 1 or 0 based on whether <em>Matrix</em> is an identity matrix.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
283 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
284 <dt><strong><a name="islefttriangular" class="item"><strong>IsLeftTriangular</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
285 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
286 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
287 $Status = $Matrix-&gt;IsLeftTriangular();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
288 <p>Returns 1 or 0 based on whether <em>Matrix</em> is a left or lower matrix.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
289 <p>A matrix is a left triangular matrix:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
290 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
291 . It's a square matrix
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
292 <br/> . All its entries above the main diagonal are zero</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
293 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
294 <dt><strong><a name="islowerbidiagonal" class="item"><strong>IsLowerBiDiagonal</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
295 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
296 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
297 $Status = $Matrix-&gt;IsLowerBiDiagonal();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
298 <p>Returns 1 or 0 based on whether <em>Matrix</em> is a lower bidiagonal matrix.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
299 <p>A matrix is a lower bidiagonal matrix:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
300 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
301 . It's a square matrix
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
302 <br/> . All its main diagonal and lower diagonal elements are non-zeros and all its
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
303 other elements are zeros</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
304 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
305 <dt><strong><a name="islowertriangular" class="item"><strong>IsLowerTriangular</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
306 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
307 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
308 $Status = $Matrix-&gt;IsLowerTriangular();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
309 <p>Returns 1 or 0 based on whether <em>Matrix</em> is a left or lower triangular matrix.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
310 <p>A matrix is a lower triangular matrix:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
311 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
312 . It's a square matrix
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
313 <br/> . All its entries above the main diagonal are zero</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
314 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
315 <dt><strong><a name="islowerunitriangular" class="item"><strong>IsLowerUniTriangular</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
316 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
317 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
318 $Status = $Matrix-&gt;IsLowerUniTriangular();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
319 <p>Returns 1 or 0 based on whether <em>Matrix</em> is a lower triangular matrix.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
320 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
321 <dt><strong><a name="ismatrix" class="item"><strong>IsMatrix</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
322 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
323 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
324 $Status = Matrix::IsMatrix($Object);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
325 <p>Returns 1 or 0 based on whether <em>Object</em> is a <strong>Matrix</strong> object.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
326 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
327 <dt><strong><a name="isnegative" class="item"><strong>IsNegative</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
328 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
329 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
330 $Status = $Matrix-&gt;IsNegative();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
331 <p>Returns 1 or 0 based on whether <em>Matrix</em> is a negative matrix containing only values
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
332 less than or equal to zero.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
333 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
334 <dt><strong><a name="ispositive" class="item"><strong>IsPositive</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
335 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
336 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
337 $Status = $Matrix-&gt;IsPositive();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
338 <p>Returns 1 or 0 based on whether <em>Matrix</em> is a negative matrix containing only values
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
339 greater than or equal to zero.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
340 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
341 <dt><strong><a name="isrighttriangular" class="item"><strong>IsRightTriangular</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
342 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
343 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
344 $Status = $Matrix-&gt;IsRightTriangular();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
345 <p>Returns 1 or 0 based on whether <em>Matrix</em> is a right or upper triangular matrix.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
346 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
347 <dt><strong><a name="isskewsymmetric" class="item"><strong>IsSkewSymmetric</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
348 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
349 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
350 $Status = $Matrix-&gt;IsSkewSymmetric();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
351 <p>Returns 1 or 0 based on whether <em>Matrix</em> is a skew or anti symmetric matrix.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
352 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
353 <dt><strong><a name="issquare" class="item"><strong>IsSquare</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
354 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
355 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
356 $Status = $Matrix-&gt;IsSquare();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
357 <p>Returns 1 or 0 based on whether <em>Matrix</em> is a square matrix containing equal
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
358 number of rows and columns.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
359 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
360 <dt><strong><a name="isstrictlylowertriangular" class="item"><strong>IsStrictlyLowerTriangular</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
361 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
362 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
363 $Status = $Matrix-&gt;IsStrictlyLowerTriangular();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
364 <p>Returns 1 or 0 based on whether <em>Matrix</em> is a strictly lower triangular matrix.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
365 <p>A matrix is a strictly lower triangular matrix:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
366 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
367 . It's a square matrix
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
368 <br/> . All its entries on and above the main diagonal are zero</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
369 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
370 <dt><strong><a name="isstrictlyuppertriangular" class="item"><strong>IsStrictlyUpperTriangular</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
371 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
372 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
373 $Status = $Matrix-&gt;IsStrictlyUpperTriangular();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
374 <p>Returns 1 or 0 based on whether <em>Matrix</em> is a strictly upper triangular matrix.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
375 <p>A matrix is a strictly upper triangular matrix:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
376 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
377 . It's a square matrix
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
378 <br/> . All its entries on and below the main diagonal are zero</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
379 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
380 <dt><strong><a name="issymmetric" class="item"><strong>IsSymmetric</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
381 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
382 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
383 $Status = $Matrix-&gt;IsSymmetric();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
384 <p>Returns 1 or 0 based on whether <em>Matrix</em> is a symmetric matrix.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
385 <p>A matrix is a symmetric matrix:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
386 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
387 . It's a square matrix
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
388 <br/> . Its elements are symmetric with respect to main diagonal. In other words,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
389 elements below the main diagonal are equal to the elements above the main
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
390 diagonal.</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
391 <p>Transpose of a symmetric matrix equals the matrix itself.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
392 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
393 <dt><strong><a name="istridiagonal" class="item"><strong>IsTriDiagonal</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
394 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
395 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
396 $Status = $Matrix-&gt;IsTriDiagonal();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
397 <p>Returns 1 or 0 based on whether <em>Matrix</em> is a tridiagonal matrix.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
398 <p>A matrix is a tribidiagonal matrix:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
399 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
400 . It's a square matrix
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
401 <br/> . All its main diagonal, upper diagonal, and lower diagonal elements are non-zeros and all its
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
402 other elements are zeros</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
403 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
404 <dt><strong><a name="isunit" class="item"><strong>IsUnit</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
405 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
406 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
407 $Status = $Matrix-&gt;IsUnit();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
408 <p>Returns 1 or 0 based on whether <em>Matrix</em> is a unit matrix.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
409 <p>A matrix is a unit matrix:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
410 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
411 . It's a square matrix
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
412 <br/> . All its diagonal elements are ones and its off-diagonal elements are zeros</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
413 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
414 <dt><strong><a name="isunitlowertriangular" class="item"><strong>IsUnitLowerTriangular</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
415 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
416 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
417 $Status = $Matrix-&gt;IsUnitLowerTriangular();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
418 <p>Returns 1 or 0 based on whether <em>Matrix</em> is an unit lower triangular matrix.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
419 <p>A matrix is an unit lower triangular matrix:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
420 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
421 . It's a square matrix
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
422 <br/> . All its entries main diagonal are one
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
423 <br/> . All its entries above the main diagonal are zero</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
424 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
425 <dt><strong><a name="isunituppertriangular" class="item"><strong>IsUnitUpperTriangular</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
426 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
427 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
428 $Status = $Matrix-&gt;IsUnitUpperTriangular();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
429 <p>Returns 1 or 0 based on whether <em>Matrix</em> is an unit upper triangular matrix.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
430 <p>A matrix is an unit upper triangular matrix:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
431 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
432 . It's a square matrix
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
433 <br/> . All its entries main diagonal are one
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
434 <br/> . All its entries below the main diagonal are zero</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
435 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
436 <dt><strong><a name="isupperbidiagonal" class="item"><strong>IsUpperBiDiagonal</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
437 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
438 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
439 $Status = $Matrix-&gt;IsUpperBiDiagonal();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
440 <p>Returns 1 or 0 based on whether <em>Matrix</em> is an upper bidiagonal matrix.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
441 <p>A matrix is an upper bidiagonal matrix:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
442 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
443 . It's a square matrix
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
444 <br/> . All its main diagonal and upper diagonal elements are non-zeros and all its
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
445 other elements are zeros</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
446 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
447 <dt><strong><a name="isuppertriangular" class="item"><strong>IsUpperTriangular</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
448 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
449 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
450 $Status = $Matrix-&gt;IsUpperTriangular();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
451 <p>Returns 1 or 0 based on whether <em>Matrix</em> is a right or upper triangular matrix.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
452 <p>A matrix is an upper triangular matrix:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
453 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
454 . It's a square matrix
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
455 <br/> . All its entries below the main diagonal are zero</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
456 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
457 <dt><strong><a name="isupperunitriangular" class="item"><strong>IsUpperUniTriangular</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
458 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
459 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
460 $Status = $Matrix-&gt;IsUpperUniTriangular();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
461 <p>Returns 1 or 0 based on whether <em>Matrix</em> is a right or upper triangular matrix.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
462 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
463 <dt><strong><a name="newfromcolumns" class="item"><strong>NewFromColumns</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
464 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
465 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
466 $NewMatrix = Matrix::NewFromColumns($Col1Vector, $Col2Vector, ...);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
467 <br/> $NewMatrix = Matrix::NewFromColumns($Col1ValuesRef, $Col2ValuesRef, ...);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
468 <br/> $NewMatrix = Matrix::NewFromColumns(&quot;Val1 Val2 ...&quot;, &quot;Val1 Val2&quot;, ...);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
469 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
470 $NewMatrix = $Matrix-&gt;NewFromColumns($Col1Vector, $Col2Vector, ...);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
471 <br/> $NewMatrix = $Matrix-&gt;NewFromColumns($Col1ValuesRef, $Col2ValuesRef, ...);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
472 <br/> $NewMatrix = $Matrix-&gt;NewFromColumns(&quot;Val1 Val2 ...&quot;, &quot;Val1 Val2&quot;, ...);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
473 <p>Creates a new <strong>Matrix</strong> using specified column values and returns <strong>NewMatrix</strong> object.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
474 <p>The column values can be specified in one of the following formats:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
475 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
476 . List of vector objects
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
477 <br/> . References to list of values
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
478 <br/> . List of strings containing columns values delimited by space</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
479 <p>Each column must contain the same number of values.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
480 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
481 <dt><strong><a name="newfromdiagonal" class="item"><strong>NewFromDiagonal</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
482 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
483 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
484 $NewMatrix = Matrix::NewFromDiagonal($DiagonalVector);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
485 <br/> $NewMatrix = Matrix::NewFromDiagonal($DiagonalValuesRef);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
486 <br/> $NewMatrix = Matrix::NewFromDiagonal(&quot;Val1 Val2 ...&quot;);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
487 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
488 $NewMatrix = Matrix-&gt;NewFromDiagonal($DiagonalVector);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
489 <br/> $NewMatrix = Matrix-&gt;NewFromDiagonal($DiagonalValuesRef);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
490 <br/> $NewMatrix = Matrix-&gt;NewFromDiagonal(&quot;Val1 Val2 ...&quot;);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
491 <p>Creates a new <strong>Matrix</strong> using specified diagonal values and returns <strong>NewMatrix</strong> object.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
492 <p>The column values can be specified in one of the following formats:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
493 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
494 . A vector object
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
495 <br/> . Reference to list of values
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
496 <br/> . Strings containing diagonal values delimited by space</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
497 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
498 <dt><strong><a name="newfromrows" class="item"><strong>NewFromRows</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
499 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
500 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
501 $NewMatrix = Matrix::NewFromRows($Row1Vector, $RowVector, ...);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
502 <br/> $NewMatrix = Matrix::NewFromRows($Row1ValuesRef, $Row2ValuesRef, ...);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
503 <br/> $NewMatrix = Matrix::NewFromRows(&quot;Val1 Val2 ...&quot;, &quot;Val1 Val2&quot;, ...);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
504 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
505 $NewMatrix = $Matrix-&gt;NewFromRows($Row1Vector, $Row2Vector, ...);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
506 <br/> $NewMatrix = $Matrix-&gt;NewFromRows($Row1ValuesRef, $Row2ValuesRef, ...);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
507 <br/> $NewMatrix = $Matrix-&gt;NewFromRows(&quot;Val1 Val2 ...&quot;, &quot;Val1 Val2&quot;, ...);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
508 <p>Creates a new <strong>Matrix</strong> using specified row values and returns <strong>NewMatrix</strong> object.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
509 <p>The row values can be specified in one of the following formats:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
510 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
511 . List of vector objects
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
512 <br/> . References to list of values
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
513 <br/> . List of strings containing columns values delimited by space</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
514 <p>Each row must contain the same number of values.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
515 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
516 <dt><strong><a name="one" class="item"><strong>One</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
517 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
518 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
519 $Matrix-&gt;One();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
520 <p>Sets values of all <em>Matrix</em> elements to 1 and returns <em>Matrix</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
521 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
522 <dt><strong><a name="setallvalues" class="item"><strong>SetAllValues</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
523 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
524 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
525 $Matrix-&gt;SetAllValues($Value);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
526 <p>Sets values of all <em>Matrix</em> elements to specified <em>Value</em> and returns <em>Matrix</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
527 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
528 <dt><strong><a name="setcolumnvalues" class="item"><strong>SetColumnValues</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
529 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
530 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
531 $Matrix-&gt;SetColumnValues($ColIndex, @Values);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
532 <br/> $Matrix-&gt;SetColumnValues($ColIndex, \@Values);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
533 <br/> $Matrix-&gt;SetColumnValues($ColIndex, $VectorObject);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
534 <br/> $Matrix-&gt;SetColumnValues($ColIndex, &quot;Value1 Value2 Value3 ...&quot;);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
535 <p>Sets column values of a specified <em>ColIndex</em> of <em>Matrix</em> using an array, reference to an array,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
536 another vector, or space delimited value string and returns <em>Matrix</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
537 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
538 <dt><strong><a name="setdiagonalvalues" class="item"><strong>SetDiagonalValues</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
539 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
540 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
541 $Matrix-&gt;SetDiagonalValues(@Values);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
542 <br/> $Matrix-&gt;SetDiagonalValues(\@Values);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
543 <br/> $Matrix-&gt;SetDiagonalValues($VectorObject);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
544 <br/> $Matrix-&gt;SetDiagonalValues(&quot;Value1 Value2 Value3 ...&quot;);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
545 <p>Sets values of the diagonal in square <em>Matrix</em> and returns <em>Matrix</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
546 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
547 <dt><strong><a name="setmatrixprintstyle" class="item"><strong>SetMatrixPrintStyle</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
548 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
549 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
550 $Matrix-&gt;SetMatrixPrintStyle($MatrixStyle);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
551 <br/> $Matrix::SetMatrixPrintStyle($MatrixStyle);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
552 <p>Sets print style for matrix rows for an individual object or the whole class during StringifyMatrix
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
553 operation. Possible <em>MatrixStyle</em> values: <em>AllRowsInOneLine, OneRowPerLine</em>. Default:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
554 <em>AllRowsInOneLine</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
555 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
556 <dt><strong><a name="setrowvalues" class="item"><strong>SetRowValues</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
557 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
558 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
559 $Matrix-&gt;SetRowValues($ColIndex, @Values);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
560 <br/> $Matrix-&gt;SetRowValues($ColIndex, \@Values);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
561 <br/> $Matrix-&gt;SetRowValues($ColIndex, $VectorObjext);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
562 <br/> $Matrix-&gt;SetRowValues($ColIndex, &quot;Value1 Value2 Value3 ...&quot;);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
563 <p>Sets row values of a specified <em>RowIndex</em> of <em>Matrix</em> using an array, reference to an array,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
564 another vector, or space delimited value string and returns <em>Matrix</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
565 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
566 <dt><strong><a name="setvalue" class="item"><strong>SetValue</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
567 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
568 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
569 $Matrix-&gt;SetValue($RowIndex, $ColIndex, $Value, [$SkipIndexCheck]);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
570 <p>Sets <strong>Value</strong> of <em>Matrix</em> element specified using <em>RowIndex</em> and <em>ColIndex</em> with indicies
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
571 starting at 0 with optional validation of specified index values and return <em>Matrix</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
572 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
573 <dt><strong><a name="setvalueprintformat" class="item"><strong>SetValuePrintFormat</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
574 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
575 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
576 $Matrix-&gt;SetValuePrintFormat($ValueFormat);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
577 <br/> $Matrix::SetValuePrintFormat($ValueFormat);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
578 <p>Sets value print format for an individual object or the whole class during StringifyMatrix operation
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
579 and returns <em>Matrix</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
580 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
581 <dt><strong><a name="stringifymatrix" class="item"><strong>StringifyMatrix</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
582 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
583 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
584 $String = $Matrix-&gt;StringifyMatrix();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
585 <p>Returns a string containing information about <em>Matrix</em> object.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
586 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
587 <dt><strong><a name="transpose" class="item"><strong>Transpose</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
588 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
589 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
590 $Matrix-&gt;Transpose();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
591 <p>Transposes <em>Matrix</em> by swaping rows with columns and returns <em>Matrix</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
592 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
593 <dt><strong><a name="unitmatrix" class="item"><strong>UnitMatrix</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
594 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
595 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
596 $NewUnitMatrix = $Matrix::UnitMatrix($NumOfRows, $NumOfCols);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
597 <br/> $NewUnitMatrix = $Matrix::UnitMatrix();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
598 <br/> $NewUnitMatrix = $Matrix-&gt;UnitMatrix($NumOfRows, $NumOfCols);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
599 <p>Creates a new <strong>UnitMatrix</strong> of specified size <em>NumOfRows x NumOfCol</em> or of size 3 x 3 and
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
600 returns <strong>NewUnitMatrix</strong> object.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
601 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
602 <dt><strong><a name="zero" class="item"><strong>Zero</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
603 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
604 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
605 $Matrix-&gt;Zero();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
606 <p>Sets values of all <em>Matrix</em> elements to 0 and returns <em>Matrix</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
607 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
608 <dt><strong><a name="zeromatrix" class="item"><strong>ZeroMatrix</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
609 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
610 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
611 $NewZeroMatrix = $Matrix::ZeroMatrix($NumOfRows, $NumOfCols);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
612 <br/> $NewZeroMatrix = $Matrix::ZeroMatrix();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
613 <br/> $NewZeroMatrix = $Matrix-&gt;ZeroMatrix($NumOfRows, $NumOfCols);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
614 <p>Creates a new <strong>ZeroMatrix</strong> of specified size <em>NumOfRows x NumOfCol</em> or of size 3 x 3 and
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
615 returns <strong>NewZeroMatrix</strong> object.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
616 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
617 </dl>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
618 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
619 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
620 <h2>AUTHOR</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
621 <p><a href="mailto:msud@san.rr.com">Manish Sud</a></p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
622 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
623 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
624 <h2>SEE ALSO</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
625 <p><a href="./Vector.html">Vector.pm</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
626 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
627 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
628 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
629 <h2>COPYRIGHT</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
630 <p>Copyright (C) 2015 Manish Sud. All rights reserved.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
631 <p>This file is part of MayaChemTools.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
632 <p>MayaChemTools is free software; you can redistribute it and/or modify it under
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
633 the terms of the GNU Lesser General Public License as published by the Free
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
634 Software Foundation; either version 3 of the License, or (at your option)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
635 any later version.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
636 <p>&nbsp</p><p>&nbsp</p><div class="DocNav">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
637 <table width="100%" border=0 cellpadding=0 cellspacing=2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
638 <tr align="left" valign="top"><td width="33%" align="left"><a href="./MathUtil.html" title="MathUtil.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./AtomsCountDescriptors.html" title="AtomsCountDescriptors.html">Next</a></td><td width="34%" align="middle"><strong>March 29, 2015</strong></td><td width="33%" align="right"><strong>Matrix.pm</strong></td></tr>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
639 </table>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
640 </div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
641 <br />
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
642 <center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
643 <img src="../../images/h2o2.png">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
644 </center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
645 </body>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
646 </html>