omatrix_const_view_tlate Class Template Reference

A const matrix view of omatrix objects. More...

#include <omatrix_tlate.h>

Inheritance diagram for omatrix_const_view_tlate:

omatrix_base_tlate omatrix_tlate omatrix_tlate< double, gsl_matrix, gsl_vector, gsl_block > omatrix_view_tlate omatrix_array_tlate

Detailed Description

template<class data_t, class mparent_t, class block_t>
class omatrix_const_view_tlate< data_t, mparent_t, block_t >

A const matrix view of omatrix objects.

Definition at line 56 of file omatrix_tlate.h.


Public Member Functions

Copy constructors
 omatrix_const_view_tlate (const omatrix_const_view_tlate &v)
 Shallow copy constructor - create a new view of the same matrix.
omatrix_const_view_tlateoperator= (const omatrix_const_view_tlate &v)
 Shallow copy constructor - create a new view of the same matrix.
Get and set methods
const data_t * operator[] (size_t i) const
 Array-like indexing.
const data_t & operator() (size_t i, size_t j) const
 Array-like indexing.
data_t get (size_t i, size_t j) const
 Get (with optional range-checking).
data_t * get_ptr (size_t i, size_t j)
 Get pointer (with optional range-checking).
const data_t * get_const_ptr (size_t i, size_t j) const
 Get pointer (with optional range-checking).
size_t rows () const
 Method to return number of rows.
size_t cols () const
 Method to return number of columns.
size_t tda () const
 Method to return matrix tda.
Other methods
bool is_owner () const
 Return true if this object owns the data it refers to.
const mparent_t * get_gsl_matrix_const () const
 Return a const gsl matrix.

Protected Member Functions

 omatrix_const_view_tlate ()
 Desc.

Member Function Documentation

size_t cols (  )  const [inline]

Method to return number of columns.

If no memory has been allocated, this will quietly return zero.

Definition at line 193 of file omatrix_tlate.h.

bool is_owner (  )  const [inline]

Return true if this object owns the data it refers to.

This can be used to determine if an object is a "matrix_view", or a "matrix". If is_owner() is true, then it is an omatrix_tlate object.

Definition at line 216 of file omatrix_tlate.h.

size_t rows (  )  const [inline]

Method to return number of rows.

If no memory has been allocated, this will quietly return zero.

Definition at line 183 of file omatrix_tlate.h.

size_t tda (  )  const [inline]

Method to return matrix tda.

If no memory has been allocated, this will quietly return zero.

Definition at line 203 of file omatrix_tlate.h.


The documentation for this class was generated from the following file:

Documentation generated with Doxygen and provided under the GNU Free Documentation License. See License Information for details.

Project hosting provided by SourceForge.net Logo, O2scl Sourceforge Project Page