get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixget_value_matrixT_get_value_matrix
Short description
get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixget_value_matrixT_get_value_matrix — Return one ore more elements of a matrix.
Signature
get_value_matrix( matrix MatrixID, integer Row, integer Column, out real Value )get_value_matrix( : : MatrixID, Row, Column : Value )void GetValueMatrix( const HTuple& MatrixID, const HTuple& Row, const HTuple& Column, HTuple* Value )static void HOperatorSet.GetValueMatrix( HTuple matrixID, HTuple row, HTuple column, out HTuple value )def get_value_matrix( matrix_id: HHandle, row: MaybeSequence[int], column: MaybeSequence[int] ) -> Sequence[float]
def get_value_matrix_s( matrix_id: HHandle, row: MaybeSequence[int], column: MaybeSequence[int] ) -> floatHerror T_get_value_matrix( const Htuple MatrixID, const Htuple Row, const Htuple Column, Htuple* Value )
HTuple HMatrix::GetValueMatrix( const HTuple& Row, const HTuple& Column ) const
double HMatrix::GetValueMatrix( Hlong Row, Hlong Column ) const
HTuple HMatrix.GetValueMatrix( HTuple row, HTuple column )
double HMatrix.GetValueMatrix( int row, int column )
Description
The operator get_value_matrixGetValueMatrix returns the values of one ore
more elements of the Matrix as a tuple of floating point
numbers. The Matrix is given by the matrix handle
MatrixIDmatrixIDmatrix_id. The row coordinates of the elements of the
Matrix are determined by the tuple Rowrowrow, the
column coordinates by the tuple Columncolumncolumn.
Example:
Rowrowrow = [0, 2, 1][0, 2, 1],
Columncolumncolumn = [1, 0, 3][1, 0, 3]
\[\begin{eqnarray*}
\texttt{Matrix} =
\left[ \begin{array}{rrrr}
3.0 & 1.0 & -2.0 & 1.0 \\
-5.0 & 7.0 & 2.0 & 6.0 \\
-9.0 & -4.0 & 1.0 & -1.0
\end{array} \right]
\end{eqnarray*}\]
\[\begin{eqnarray*} \to \qquad \textrm{Value} = [1.0,-9.0,6.0] \end{eqnarray*}\]
Execution information
-
Multithreading type: reentrant (runs in parallel with non-exclusive operators).
-
Multithreading scope: global (may be called from any thread).
-
Processed without parallelization.
Parameters
MatrixIDmatrixIDmatrix_id (input_control) matrix → (handle)(handle)HTuple (HHandle)HMatrix, HTuple (IntPtr)HHandleHtuple (handle)
Matrix handle of the input matrix.
Rowrowrow (input_control) integer(-array) → (integer)(integer)HTuple (Hlong)HTuple (int / long)MaybeSequence[int]Htuple (Hlong)
Row numbers of matrix elements to be returned.
Default: 00
Suggested values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 30, 50, 1000, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 30, 50, 100
Restriction: Row >= 0
Columncolumncolumn (input_control) integer(-array) → (integer)(integer)HTuple (Hlong)HTuple (int / long)MaybeSequence[int]Htuple (Hlong)
Column numbers of matrix elements to be returned.
Default: 00
Suggested values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 30, 50, 1000, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 30, 50, 100
Restriction: Column >= 0
Valuevaluevalue (output_control) real(-array) → (real)(real)HTuple (double)HTuple (double)Sequence[float]Htuple (double)
Values of indicated matrix elements.
Result
If the parameters are valid, the operator get_value_matrixGetValueMatrix
returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.
Combinations with other operators
Combinations
Possible predecessors
create_matrixCreateMatrix
Possible successors
clear_matrixClearMatrix
See also
set_value_matrixSetValueMatrix
Module
Foundation