vnl_matrix_fixed_ref< T, num_rows, num_cols > Class Template Reference

#include <vnl_matrix_fixed_ref.h>

Inheritance diagram for vnl_matrix_fixed_ref< T, num_rows, num_cols >:

vnl_matrix_fixed_ref_const< T, num_rows, num_cols > List of all members.

Detailed Description

template<class T, unsigned num_rows, unsigned num_cols>
class vnl_matrix_fixed_ref< T, num_rows, num_cols >

Definition at line 389 of file vnl_matrix_fixed_ref.h.


Public Types

typedef T element_type
 Type defs for iterators.
typedef T * iterator
 Iterators.
typedef T const * const_iterator
 Const iterators.
typedef vnl_c_vector< T
>::abs_t 
abs_t
 Type def for norms.

Public Member Functions

T * data_block () const
 vnl_matrix_fixed_ref (vnl_matrix_fixed< T, num_rows, num_cols > &rhs)
 vnl_matrix_fixed_ref (T *dataptr)
vnl_matrix_fixed_ref const & operator= (const vnl_matrix_fixed_ref_const< T, num_rows, num_cols > &rhs) const
 Copy another vnl_matrix_fixed<T,m,n> into this.
void put (unsigned r, unsigned c, T const &v)
 set element.
get (unsigned r, unsigned c) const
 get element.
T * operator[] (unsigned r) const
 return pointer to given row.
T & operator() (unsigned r, unsigned c) const
 Access an element for reading or writing.
void fill (T) const
 Set all elements of matrix to specified value.
void fill_diagonal (T) const
 Set all diagonal elements of matrix to specified value.
void copy_in (T const *) const
 Fill (laminate) this matrix with the given data.
void set (T const *d) const
 Fill (laminate) this matrix with the given data.
void inplace_transpose () const
 Transpose this matrix efficiently, if it is a square matrix.
vnl_matrix_fixed_ref const & operator+= (T s) const
 Add s to each element of lhs matrix in situ.
vnl_matrix_fixed_ref const & operator-= (T s) const
 Subtract s from each element of lhs matrix in situ.
vnl_matrix_fixed_ref const & operator *= (T s) const
vnl_matrix_fixed_ref const & operator/= (T s) const
vnl_matrix_fixed_ref const & operator+= (vnl_matrix_fixed_ref_const < T, num_rows, num_cols > const &m) const
vnl_matrix_fixed_ref const & operator+= (vnl_matrix< T > const &m) const
vnl_matrix_fixed_ref const & operator-= (vnl_matrix_fixed_ref_const < T, num_rows, num_cols > const &m) const
vnl_matrix_fixed_ref const & operator-= (vnl_matrix< T > const &m) const
vnl_matrix_fixed< T, num_rows,
num_cols > 
operator- () const
 Negate all elements of matrix.
vnl_matrix_fixed_ref const & operator *= (vnl_matrix_fixed_ref_const < T, num_cols, num_cols > const &s) const
vnl_matrix_fixed_ref const & update (vnl_matrix< T > const &, unsigned top=0, unsigned left=0) const
 Set values of this matrix to those of M, starting at [top,left].
void set_column (unsigned i, T const *v) const
 Set the elements of the i'th column to v[j] (No bounds checking).
void set_column (unsigned i, T value) const
 Set the elements of the i'th column to value.
void set_column (unsigned j, vnl_vector< T > const &v) const
 Set j-th column to v.
void set_columns (unsigned starting_column, vnl_matrix< T > const &M) const
 Set columns to those in M, starting at starting_column.
void set_row (unsigned i, T const *v) const
 Set the elements of the i'th row to v[j] (No bounds checking).
void set_row (unsigned i, T value) const
 Set the elements of the i'th row to value.
void set_row (unsigned i, vnl_vector< T > const &) const
 Set the i-th row.
void set_identity () const
 Set this matrix to an identity matrix.
void flipud () const
 Reverse order of rows.
void fliplr () const
 Reverse order of columns.
void normalize_rows () const
 Normalize each row so it is a unit vector.
void normalize_columns () const
 Normalize each column so it is a unit vector.
void scale_row (unsigned row, T value) const
 Scale elements in given row by a factor of T.
void scale_column (unsigned col, T value) const
 Scale elements in given column by a factor of T.
bool read_ascii (vcl_istream &s) const
vnl_matrix_ref< T > as_ref ()
 Explicit conversion to a vnl_matrix_ref.
const vnl_matrix_ref< T > as_ref () const
 Explicit conversion to a vnl_matrix_ref.
 operator const vnl_matrix_ref () const
 Cheap conversion to vnl_matrix_ref.
const vnl_matrix< T > as_matrix () const
 Convert to a vnl_matrix.
iterator begin () const
 Iterator pointing to start of data.
iterator end () const
 Iterator pointing to element beyond end of data.
bool operator_eq (vnl_matrix_fixed_ref_const < T, num_rows, num_cols > const &rhs) const
 Return true if *this == rhs.
bool operator== (vnl_matrix_fixed_ref_const < T, num_rows, num_cols > const &that) const
 Equality operator.
bool operator!= (vnl_matrix_fixed_ref_const < T, num_rows, num_cols > const &that) const
 Inequality operator.
vnl_vector_fixed< T, num_rows > get_row (unsigned row_index) const
 Get j-th row.
vnl_vector_fixed< T, num_cols > get_column (unsigned column_index) const
 Get j-th column.
unsigned rows () const
 Return number of rows.
unsigned columns () const
 Return number of columns.
unsigned cols () const
 Return number of columns.
unsigned size () const
 Return number of elements.
void print (vcl_ostream &os) const
 Print matrix to os in some hopefully sensible format.
void copy_out (T *) const
vnl_matrix_fixed< T, num_rows,
num_cols > 
apply (T(*f)(T)) const
 Make a new matrix by applying function to each element.
vnl_matrix_fixed< T, num_rows,
num_cols > 
apply (T(*f)(T const &)) const
 Make a new matrix by applying function to each element.
vnl_matrix_fixed< T, num_cols,
num_rows > 
transpose () const
 Return transpose.
vnl_matrix_fixed< T, num_cols,
num_rows > 
conjugate_transpose () const
 Return conjugate transpose.
vnl_matrix< T > extract (unsigned rowz, unsigned colz, unsigned top=0, unsigned left=0) const
 Extract a sub-matrix of size rows x cols, starting at (top,left).
vnl_matrix< T > get_n_rows (unsigned rowstart, unsigned n) const
 Get n rows beginning at rowstart.
vnl_matrix< T > get_n_columns (unsigned colstart, unsigned n) const
 Get n columns beginning at colstart.
abs_t array_one_norm () const
 Return sum of absolute values of elements.
abs_t array_two_norm () const
 Return square root of sum of squared absolute element values.
abs_t array_inf_norm () const
 Return largest absolute element value.
abs_t absolute_value_sum () const
 Return sum of absolute values of elements.
abs_t absolute_value_max () const
 Return largest absolute value.
abs_t operator_one_norm () const
abs_t operator_inf_norm () const
abs_t frobenius_norm () const
 Return Frobenius norm of matrix (sqrt of sum of squares of its elements).
abs_t fro_norm () const
 Return Frobenius norm of matrix (sqrt of sum of squares of its elements).
abs_t rms () const
 Return RMS of all elements.
min_value () const
 Return minimum value of elements.
max_value () const
 Return maximum value of elements.
unsigned arg_min () const
 Return location of minimum value of elements.
unsigned arg_max () const
 Return location of maximum value of elements.
mean () const
 Return mean of all matrix elements.
bool empty () const
 Return true iff the size is zero.
bool is_identity () const
 Return true if all elements equal to identity.
bool is_identity (double tol) const
 Return true if all elements equal to identity, within given tolerance.
bool is_zero () const
 Return true if all elements equal to zero.
bool is_zero (double tol) const
 Return true if all elements equal to zero, within given tolerance.
bool is_finite () const
 Return true if finite.
bool has_nans () const
 Return true if matrix contains NaNs.
void assert_size (unsigned rowz, unsigned colz) const
 abort if size is not as expected.
void assert_finite () const
 abort if matrix contains any INFs or NANs.

Static Public Member Functions

static void add (const T *a, const T *b, T *r)
static void add (const T *a, T b, T *r)
static void sub (const T *a, const T *b, T *r)
static void sub (const T *a, T b, T *r)
static void sub (T a, const T *b, T *r)
static void mul (const T *a, const T *b, T *r)
static void mul (const T *a, T b, T *r)
static void div (const T *a, const T *b, T *r)
static void div (const T *a, T b, T *r)
static bool equal (const T *a, const T *b)

Protected Attributes

const T * data_

Private Types

typedef vnl_matrix_fixed_ref_const<
T, num_rows, num_cols > 
base

Member Typedef Documentation

template<class T, unsigned num_rows, unsigned num_cols>
typedef vnl_matrix_fixed_ref_const<T,num_rows,num_cols> vnl_matrix_fixed_ref< T, num_rows, num_cols >::base [private]

Definition at line 391 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
typedef T vnl_matrix_fixed_ref< T, num_rows, num_cols >::element_type

Type defs for iterators.

Reimplemented from vnl_matrix_fixed_ref_const< T, num_rows, num_cols >.

Definition at line 642 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
typedef T* vnl_matrix_fixed_ref< T, num_rows, num_cols >::iterator

Iterators.

Reimplemented from vnl_matrix_fixed_ref_const< T, num_rows, num_cols >.

Definition at line 645 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
typedef T const* vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::const_iterator [inherited]

Const iterators.

Definition at line 206 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
typedef vnl_c_vector<T>::abs_t vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::abs_t [inherited]

Type def for norms.

Definition at line 276 of file vnl_matrix_fixed_ref.h.


Constructor & Destructor Documentation

template<class T, unsigned num_rows, unsigned num_cols>
vnl_matrix_fixed_ref< T, num_rows, num_cols >::vnl_matrix_fixed_ref ( vnl_matrix_fixed< T, num_rows, num_cols > &  rhs  )  [inline]

Definition at line 399 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
vnl_matrix_fixed_ref< T, num_rows, num_cols >::vnl_matrix_fixed_ref ( T *  dataptr  )  [inline, explicit]

Definition at line 403 of file vnl_matrix_fixed_ref.h.


Member Function Documentation

template<class T, unsigned num_rows, unsigned num_cols>
T* vnl_matrix_fixed_ref< T, num_rows, num_cols >::data_block (  )  const [inline]

Reimplemented from vnl_matrix_fixed_ref_const< T, num_rows, num_cols >.

Definition at line 396 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
vnl_matrix_fixed_ref const& vnl_matrix_fixed_ref< T, num_rows, num_cols >::operator= ( const vnl_matrix_fixed_ref_const< T, num_rows, num_cols > &  rhs  )  const [inline]

Copy another vnl_matrix_fixed<T,m,n> into this.

Reimplemented from vnl_matrix_fixed_ref_const< T, num_rows, num_cols >.

Definition at line 409 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
void vnl_matrix_fixed_ref< T, num_rows, num_cols >::put ( unsigned  r,
unsigned  c,
T const &  v 
) [inline]

set element.

Definition at line 418 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
T vnl_matrix_fixed_ref< T, num_rows, num_cols >::get ( unsigned  r,
unsigned  c 
) const [inline]

get element.

Definition at line 421 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
T* vnl_matrix_fixed_ref< T, num_rows, num_cols >::operator[] ( unsigned  r  )  const [inline]

return pointer to given row.

No boundary checking here.

Reimplemented from vnl_matrix_fixed_ref_const< T, num_rows, num_cols >.

Definition at line 425 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
T& vnl_matrix_fixed_ref< T, num_rows, num_cols >::operator() ( unsigned  r,
unsigned  c 
) const [inline]

Access an element for reading or writing.

There are assert style boundary checks - define NDEBUG to turn them off.

Reimplemented from vnl_matrix_fixed_ref_const< T, num_rows, num_cols >.

Definition at line 429 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned nrows, unsigned ncols>
void vnl_matrix_fixed_ref< T, nrows, ncols >::fill (  )  const

Set all elements of matrix to specified value.

Complexity $O(r.c)$

Definition at line 116 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
void vnl_matrix_fixed_ref< T, nrows, ncols >::fill_diagonal (  )  const

Set all diagonal elements of matrix to specified value.

Complexity $O(\min(r,c))$

Definition at line 126 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
void vnl_matrix_fixed_ref< T, nrows, ncols >::copy_in ( T const *   )  const

Fill (laminate) this matrix with the given data.

We assume that p points to a contiguous rows*cols array, stored rowwise.

Definition at line 231 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned num_rows, unsigned num_cols>
void vnl_matrix_fixed_ref< T, num_rows, num_cols >::set ( T const *  d  )  const [inline]

Fill (laminate) this matrix with the given data.

A synonym for copy_in()

Definition at line 454 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned nrows, unsigned ncols>
void vnl_matrix_fixed_ref< T, nrows, ncols >::inplace_transpose (  )  const

Transpose this matrix efficiently, if it is a square matrix.

Definition at line 681 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned num_rows, unsigned num_cols>
vnl_matrix_fixed_ref const& vnl_matrix_fixed_ref< T, num_rows, num_cols >::operator+= ( s  )  const [inline]

Add s to each element of lhs matrix in situ.

Definition at line 468 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
vnl_matrix_fixed_ref const& vnl_matrix_fixed_ref< T, num_rows, num_cols >::operator-= ( s  )  const [inline]

Subtract s from each element of lhs matrix in situ.

Definition at line 474 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
vnl_matrix_fixed_ref const& vnl_matrix_fixed_ref< T, num_rows, num_cols >::operator *= ( s  )  const [inline]

Definition at line 480 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
vnl_matrix_fixed_ref const& vnl_matrix_fixed_ref< T, num_rows, num_cols >::operator/= ( s  )  const [inline]

Definition at line 486 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
vnl_matrix_fixed_ref const& vnl_matrix_fixed_ref< T, num_rows, num_cols >::operator+= ( vnl_matrix_fixed_ref_const< T, num_rows, num_cols > const &  m  )  const [inline]

Definition at line 492 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
vnl_matrix_fixed_ref const& vnl_matrix_fixed_ref< T, num_rows, num_cols >::operator+= ( vnl_matrix< T > const &  m  )  const [inline]

Definition at line 498 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
vnl_matrix_fixed_ref const& vnl_matrix_fixed_ref< T, num_rows, num_cols >::operator-= ( vnl_matrix_fixed_ref_const< T, num_rows, num_cols > const &  m  )  const [inline]

Definition at line 505 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
vnl_matrix_fixed_ref const& vnl_matrix_fixed_ref< T, num_rows, num_cols >::operator-= ( vnl_matrix< T > const &  m  )  const [inline]

Definition at line 511 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
vnl_matrix_fixed<T,num_rows,num_cols> vnl_matrix_fixed_ref< T, num_rows, num_cols >::operator- (  )  const [inline]

Negate all elements of matrix.

Definition at line 518 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
vnl_matrix_fixed_ref const& vnl_matrix_fixed_ref< T, num_rows, num_cols >::operator *= ( vnl_matrix_fixed_ref_const< T, num_cols, num_cols > const &  s  )  const [inline]

Definition at line 526 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned nrows, unsigned ncols>
vnl_matrix_fixed_ref< T, nrows, ncols > const & vnl_matrix_fixed_ref< T, nrows, ncols >::update ( vnl_matrix< T > const &  ,
unsigned  top = 0,
unsigned  left = 0 
) const

Set values of this matrix to those of M, starting at [top,left].

Definition at line 192 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
void vnl_matrix_fixed_ref< T, nrows, ncols >::set_column ( unsigned  i,
T const *  v 
) const

Set the elements of the i'th column to v[j] (No bounds checking).

Definition at line 433 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
void vnl_matrix_fixed_ref< T, nrows, ncols >::set_column ( unsigned  i,
value 
) const

Set the elements of the i'th column to value.

Definition at line 448 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
void vnl_matrix_fixed_ref< T, nrows, ncols >::set_column ( unsigned  j,
vnl_vector< T > const &  v 
) const

Set j-th column to v.

Definition at line 441 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
void vnl_matrix_fixed_ref< T, nrows, ncols >::set_columns ( unsigned  starting_column,
vnl_matrix< T > const &  M 
) const

Set columns to those in M, starting at starting_column.

Definition at line 457 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
void vnl_matrix_fixed_ref< T, nrows, ncols >::set_row ( unsigned  i,
T const *  v 
) const

Set the elements of the i'th row to v[j] (No bounds checking).

Definition at line 408 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
void vnl_matrix_fixed_ref< T, nrows, ncols >::set_row ( unsigned  i,
value 
) const

Set the elements of the i'th row to value.

Definition at line 423 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
void vnl_matrix_fixed_ref< T, nrows, ncols >::set_row ( unsigned  i,
vnl_vector< T > const &   
) const

Set the i-th row.

Definition at line 416 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
void vnl_matrix_fixed_ref< T, nrows, ncols >::set_identity (  )  const

Set this matrix to an identity matrix.

Abort if the matrix is not square

Definition at line 250 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
void vnl_matrix_fixed_ref< T, nrows, ncols >::flipud (  )  const

Reverse order of rows.

Definition at line 616 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
void vnl_matrix_fixed_ref< T, nrows, ncols >::fliplr (  )  const

Reverse order of columns.

Definition at line 633 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
void vnl_matrix_fixed_ref< T, nrows, ncols >::normalize_rows (  )  const

Normalize each row so it is a unit vector.

Zero rows are ignored

Definition at line 269 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
void vnl_matrix_fixed_ref< T, nrows, ncols >::normalize_columns (  )  const

Normalize each column so it is a unit vector.

Zero columns are ignored

Definition at line 294 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
void vnl_matrix_fixed_ref< T, nrows, ncols >::scale_row ( unsigned  row,
value 
) const

Scale elements in given row by a factor of T.

Definition at line 318 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
void vnl_matrix_fixed_ref< T, nrows, ncols >::scale_column ( unsigned  col,
value 
) const

Scale elements in given column by a factor of T.

Definition at line 330 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
bool vnl_matrix_fixed_ref< T, nrows, ncols >::read_ascii ( vcl_istream &  s  )  const

Definition at line 598 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned num_rows, unsigned num_cols>
vnl_matrix_ref<T> vnl_matrix_fixed_ref< T, num_rows, num_cols >::as_ref (  )  [inline]

Explicit conversion to a vnl_matrix_ref.

This is a cheap conversion for those functions that have an interface for vnl_matrix_ref but not for vnl_matrix_fixed_ref. There is also a conversion operator that should work most of the time.

See also:
vnl_matrix_ref::non_const

Definition at line 622 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
const vnl_matrix_ref<T> vnl_matrix_fixed_ref< T, num_rows, num_cols >::as_ref (  )  const [inline]

Explicit conversion to a vnl_matrix_ref.

This is a cheap conversion for those functions that have an interface for vnl_matrix_ref but not for vnl_matrix_fixed_ref. There is also a conversion operator that should work most of the time.

See also:
vnl_matrix_ref::non_const

Definition at line 629 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
vnl_matrix_fixed_ref< T, num_rows, num_cols >::operator const vnl_matrix_ref (  )  const [inline]

Cheap conversion to vnl_matrix_ref.

Sometimes, such as with templated functions, the compiler cannot use this user-defined conversion. For those cases, use the explicit as_ref() method instead.

Definition at line 635 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
const vnl_matrix<T> vnl_matrix_fixed_ref< T, num_rows, num_cols >::as_matrix (  )  const [inline]

Convert to a vnl_matrix.

Definition at line 638 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
iterator vnl_matrix_fixed_ref< T, num_rows, num_cols >::begin (  )  const [inline]

Iterator pointing to start of data.

Reimplemented from vnl_matrix_fixed_ref_const< T, num_rows, num_cols >.

Definition at line 647 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
iterator vnl_matrix_fixed_ref< T, num_rows, num_cols >::end (  )  const [inline]

Iterator pointing to element beyond end of data.

Reimplemented from vnl_matrix_fixed_ref_const< T, num_rows, num_cols >.

Definition at line 649 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
bool vnl_matrix_fixed_ref< T, num_rows, num_cols >::operator_eq ( vnl_matrix_fixed_ref_const< T, num_rows, num_cols > const &  rhs  )  const [inline]

Return true if *this == rhs.

Definition at line 653 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
bool vnl_matrix_fixed_ref< T, num_rows, num_cols >::operator== ( vnl_matrix_fixed_ref_const< T, num_rows, num_cols > const &  that  )  const [inline]

Equality operator.

Definition at line 659 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
bool vnl_matrix_fixed_ref< T, num_rows, num_cols >::operator!= ( vnl_matrix_fixed_ref_const< T, num_rows, num_cols > const &  that  )  const [inline]

Inequality operator.

Definition at line 662 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
vnl_vector_fixed<T,num_rows> vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::get_row ( unsigned  row_index  )  const [inline, inherited]

Get j-th row.

Definition at line 187 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
vnl_vector_fixed<T,num_cols> vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::get_column ( unsigned  column_index  )  const [inline, inherited]

Get j-th column.

Definition at line 196 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
unsigned vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::rows (  )  const [inline, inherited]

Return number of rows.

Definition at line 231 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
unsigned vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::columns (  )  const [inline, inherited]

Return number of columns.

A synonym for cols()

Definition at line 235 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
unsigned vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::cols (  )  const [inline, inherited]

Return number of columns.

A synonym for columns()

Definition at line 239 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
unsigned vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::size (  )  const [inline, inherited]

Return number of elements.

This equals rows() * cols()

Definition at line 243 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned nrows, unsigned ncols>
void vnl_matrix_fixed_ref_const< T, nrows, ncols >::print ( vcl_ostream &  os  )  const [inherited]

Print matrix to os in some hopefully sensible format.

Definition at line 135 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
void vnl_matrix_fixed_ref_const< T, nrows, ncols >::copy_out ( T *   )  const [inherited]

Definition at line 240 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
vnl_matrix_fixed< T, nrows, ncols > vnl_matrix_fixed_ref_const< T, nrows, ncols >::apply ( T(*)(T)  f  )  const [inherited]

Make a new matrix by applying function to each element.

Definition at line 158 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
vnl_matrix_fixed< T, nrows, ncols > vnl_matrix_fixed_ref_const< T, nrows, ncols >::apply ( T(*)(T const &)  f  )  const [inherited]

Make a new matrix by applying function to each element.

Definition at line 149 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
vnl_matrix_fixed< T, ncols, nrows > vnl_matrix_fixed_ref_const< T, nrows, ncols >::transpose (  )  const [inherited]

Return transpose.

Definition at line 170 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
vnl_matrix_fixed< T, ncols, nrows > vnl_matrix_fixed_ref_const< T, nrows, ncols >::conjugate_transpose (  )  const [inherited]

Return conjugate transpose.

Definition at line 181 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
vnl_matrix< T > vnl_matrix_fixed_ref_const< T, nrows, ncols >::extract ( unsigned  rowz,
unsigned  colz,
unsigned  top = 0,
unsigned  left = 0 
) const [inherited]

Extract a sub-matrix of size rows x cols, starting at (top,left).

Thus it contains elements [top,top+rows-1][left,left+cols-1]

Definition at line 211 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
vnl_matrix< T > vnl_matrix_fixed_ref_const< T, nrows, ncols >::get_n_rows ( unsigned  rowstart,
unsigned  n 
) const [inherited]

Get n rows beginning at rowstart.

Definition at line 343 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
vnl_matrix< T > vnl_matrix_fixed_ref_const< T, nrows, ncols >::get_n_columns ( unsigned  colstart,
unsigned  n 
) const [inherited]

Get n columns beginning at colstart.

Definition at line 356 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned num_rows, unsigned num_cols>
abs_t vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::array_one_norm (  )  const [inline, inherited]

Return sum of absolute values of elements.

Definition at line 279 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
abs_t vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::array_two_norm (  )  const [inline, inherited]

Return square root of sum of squared absolute element values.

Definition at line 282 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
abs_t vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::array_inf_norm (  )  const [inline, inherited]

Return largest absolute element value.

Definition at line 285 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
abs_t vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::absolute_value_sum (  )  const [inline, inherited]

Return sum of absolute values of elements.

Definition at line 288 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
abs_t vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::absolute_value_max (  )  const [inline, inherited]

Return largest absolute value.

Definition at line 291 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned nrows, unsigned ncols>
vnl_matrix_fixed_ref_const< T, nrows, ncols >::abs_t vnl_matrix_fixed_ref_const< T, nrows, ncols >::operator_one_norm (  )  const [inherited]

Definition at line 649 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
vnl_matrix_fixed_ref_const< T, nrows, ncols >::abs_t vnl_matrix_fixed_ref_const< T, nrows, ncols >::operator_inf_norm (  )  const [inherited]

Definition at line 665 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned num_rows, unsigned num_cols>
abs_t vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::frobenius_norm (  )  const [inline, inherited]

Return Frobenius norm of matrix (sqrt of sum of squares of its elements).

Definition at line 300 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
abs_t vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::fro_norm (  )  const [inline, inherited]

Return Frobenius norm of matrix (sqrt of sum of squares of its elements).

Definition at line 303 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
abs_t vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::rms (  )  const [inline, inherited]

Return RMS of all elements.

Definition at line 306 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
T vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::min_value (  )  const [inline, inherited]

Return minimum value of elements.

Definition at line 309 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
T vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::max_value (  )  const [inline, inherited]

Return maximum value of elements.

Definition at line 312 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
unsigned vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::arg_min (  )  const [inline, inherited]

Return location of minimum value of elements.

Definition at line 315 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
unsigned vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::arg_max (  )  const [inline, inherited]

Return location of maximum value of elements.

Definition at line 318 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
T vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::mean (  )  const [inline, inherited]

Return mean of all matrix elements.

Definition at line 321 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
bool vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::empty (  )  const [inline, inherited]

Return true iff the size is zero.

Definition at line 326 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned nrows, unsigned ncols>
bool vnl_matrix_fixed_ref_const< T, nrows, ncols >::is_identity (  )  const [inherited]

Return true if all elements equal to identity.

Definition at line 475 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
bool vnl_matrix_fixed_ref_const< T, nrows, ncols >::is_identity ( double  tol  )  const [inherited]

Return true if all elements equal to identity, within given tolerance.

Definition at line 492 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
bool vnl_matrix_fixed_ref_const< T, nrows, ncols >::is_zero (  )  const [inherited]

Return true if all elements equal to zero.

Definition at line 508 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
bool vnl_matrix_fixed_ref_const< T, nrows, ncols >::is_zero ( double  tol  )  const [inherited]

Return true if all elements equal to zero, within given tolerance.

Definition at line 521 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
bool vnl_matrix_fixed_ref_const< T, nrows, ncols >::is_finite (  )  const [inherited]

Return true if finite.

Definition at line 545 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned nrows, unsigned ncols>
bool vnl_matrix_fixed_ref_const< T, nrows, ncols >::has_nans (  )  const [inherited]

Return true if matrix contains NaNs.

Definition at line 533 of file vnl_matrix_fixed_ref.txx.

template<class T, unsigned num_rows, unsigned num_cols>
void vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::assert_size ( unsigned  rowz,
unsigned  colz 
) const [inline, inherited]

abort if size is not as expected.

This function does or tests nothing if NDEBUG is defined

Definition at line 348 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
void vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::assert_finite (  )  const [inline, inherited]

abort if matrix contains any INFs or NANs.

This function does or tests nothing if NDEBUG is defined

Definition at line 356 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
static void vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::add ( const T *  a,
const T *  b,
T *  r 
) [inline, static, inherited]

Definition at line 363 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
static void vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::add ( const T *  a,
b,
T *  r 
) [inline, static, inherited]

Definition at line 364 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
static void vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::sub ( const T *  a,
const T *  b,
T *  r 
) [inline, static, inherited]

Definition at line 365 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
static void vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::sub ( const T *  a,
b,
T *  r 
) [inline, static, inherited]

Definition at line 366 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
static void vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::sub ( a,
const T *  b,
T *  r 
) [inline, static, inherited]

Definition at line 367 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
static void vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::mul ( const T *  a,
const T *  b,
T *  r 
) [inline, static, inherited]

Definition at line 368 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
static void vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::mul ( const T *  a,
b,
T *  r 
) [inline, static, inherited]

Definition at line 369 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
static void vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::div ( const T *  a,
const T *  b,
T *  r 
) [inline, static, inherited]

Definition at line 370 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
static void vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::div ( const T *  a,
b,
T *  r 
) [inline, static, inherited]

Definition at line 371 of file vnl_matrix_fixed_ref.h.

template<class T, unsigned num_rows, unsigned num_cols>
static bool vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::equal ( const T *  a,
const T *  b 
) [inline, static, inherited]

Definition at line 373 of file vnl_matrix_fixed_ref.h.


Member Data Documentation

template<class T, unsigned num_rows, unsigned num_cols>
const T* vnl_matrix_fixed_ref_const< T, num_rows, num_cols >::data_ [protected, inherited]

Definition at line 172 of file vnl_matrix_fixed_ref.h.


The documentation for this class was generated from the following files:
Generated on Mon Mar 8 05:06:52 2010 for core/vnl by  doxygen 1.5.1