Skip to content

get_full_matrixGetFullMatrixGetFullMatrixget_full_matrixT_get_full_matrix🔗

Short description🔗

get_full_matrixGetFullMatrixGetFullMatrixget_full_matrixT_get_full_matrix — Return all values of a matrix.

Signature🔗

get_full_matrix( matrix MatrixID, out real Values )void GetFullMatrix( const HTuple& MatrixID, HTuple* Values )static void HOperatorSet.GetFullMatrix( HTuple matrixID, out HTuple values )def get_full_matrix( matrix_id: HHandle ) -> Sequence[float]

def get_full_matrix_s( matrix_id: HHandle ) -> floatHerror T_get_full_matrix( const Htuple MatrixID, Htuple* Values )

HTuple HMatrix::GetFullMatrix( ) const

HTuple HMatrix.GetFullMatrix( )

Description🔗

The operator get_full_matrixGetFullMatrix returns the values of all elements of the Matrix given by the matrix handle MatrixIDmatrixIDmatrix_id. The output parameter Valuesvaluesvalues is a tuple of floating point numbers and contains all values in a row-major order, i.e., line by line.

Example:

\[\begin{eqnarray*} \texttt{Matrix} = \left[ \begin{array}{rrr} 3.0 & 1.0 & -2.0 \\ -5.0 & 7.0 & 2.0 \\ -9.0 & -4.0 & 1.0 \end{array} \right] \qquad \to \qquad \textrm{Values} = [3.0,1.0,-2.0,-5.0,7.0,2.0,-9.0,-4.0,1.0] \end{eqnarray*}\]

Execution information🔗

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)HTuple (HHandle)HMatrix, HTuple (IntPtr)HHandleHtuple (handle)

Matrix handle of the input matrix.

Valuesvaluesvalues (output_control) real(-array) → (real)HTuple (double)HTuple (double)Sequence[float]Htuple (double)

Values of the matrix elements.

Result🔗

If the parameters are valid, the operator get_full_matrixGetFullMatrix 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_full_matrixSetFullMatrix

Module🔗

Foundation