Object-oriented Scientific Computing Library: Version 0.910
Protected Member Functions
omatrix_const_view_tlate< data_t, mparent_t, block_t > Class Template Reference

A const matrix view of omatrix objects.

#include <omatrix_tlate.h>

Inheritance diagram for omatrix_const_view_tlate< data_t, mparent_t, block_t >:
omatrix_base_tlate< data_t, mparent_t, block_t > omatrix_tlate< data_t, mparent_t, vparent_t, block_t > omatrix_tlate< double, gsl_matrix, gsl_vector, gsl_block > omatrix_view_tlate< data_t, mparent_t, block_t > ofmatrix< N, M > omatrix_array_tlate< data_t, mparent_t, block_t >

Detailed Description

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

Definition at line 55 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.
data_t max () const
 The largest matrix element.
data_t min () const
 The smallest matrix element.
const mparent_t * get_gsl_matrix_const () const
 Return a const gsl matrix.

Protected Member Functions

 omatrix_const_view_tlate ()
 The default constructor.

Member Function Documentation

template<class data_t, class mparent_t, class block_t>
size_t omatrix_const_view_tlate< data_t, mparent_t, block_t >::rows ( ) const [inline]

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

Definition at line 179 of file omatrix_tlate.h.

template<class data_t, class mparent_t, class block_t>
size_t omatrix_const_view_tlate< data_t, mparent_t, block_t >::cols ( ) const [inline]

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

Definition at line 188 of file omatrix_tlate.h.

template<class data_t, class mparent_t, class block_t>
size_t omatrix_const_view_tlate< data_t, mparent_t, block_t >::tda ( ) const [inline]

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

Definition at line 197 of file omatrix_tlate.h.

template<class data_t, class mparent_t, class block_t>
bool omatrix_const_view_tlate< data_t, mparent_t, block_t >::is_owner ( ) const [inline]

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 210 of file omatrix_tlate.h.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Documentation generated with Doxygen. Provided under the GNU Free Documentation License (see License Information).

Get Object-oriented Scientific Computing
Lib at SourceForge.net. Fast, secure and Free Open Source software
downloads.