VNL_MATRIX_FIXED_VCL60_WORKAROUND< T, num_rows, num_cols > Class Template Reference

#include <vnl_matrix_fixed.h>

Detailed Description

template<class T, unsigned int num_rows, unsigned int num_cols>
class VNL_MATRIX_FIXED_VCL60_WORKAROUND< T, num_rows, num_cols >

Fixed size, stack-stored, space-efficient matrix.

vnl_matrix_fixed is a fixed-length, stack storage vector. It has the same storage size as a C-style array. It is not related via inheritance to vnl_matrix. However, it can be converted cheaply to a vnl_matrix_ref.

Read the overview documentation of vnl_vector_fixed. The text there applies here.

Definition at line 107 of file vnl_matrix_fixed.h.


Public Types
typedef vnl_matrix_fixed< T, num_rows, num_cols >	self
typedef unsigned int	size_type
typedef vnl_c_vector< T >::abs_t	abs_t
	Type def for norms.
typedef T	element_type
typedef T *	iterator
	Iterators.
typedef T const *	const_iterator
	Const iterators.
Public Member Functions
	vnl_matrix_fixed ()
	Construct an empty num_rows*num_cols matrix.
	vnl_matrix_fixed (unsigned n, unsigned m)
	Construct an empty num_rows*num_cols matrix.
	vnl_matrix_fixed (T value)
	Construct an m*n matrix and fill with value.
	vnl_matrix_fixed (const T *datablck)
	Construct an m*n Matrix and copy data into it row-wise.
	vnl_matrix_fixed (const vnl_matrix_fixed &rhs)
	Construct an m*n Matrix and copy rhs into it.
	vnl_matrix_fixed (const vnl_matrix< T > &rhs)
	Construct an m*n Matrix and copy rhs into it.
	~vnl_matrix_fixed ()
vnl_matrix_fixed &	operator= (T const &v)
	Set all elements to value v.
vnl_matrix_fixed &	operator= (const vnl_matrix< T > &rhs)
	Copy a vnl_matrix into this.
vnl_matrix_fixed &	operator= (const vnl_matrix_fixed &rhs)
	Copy another vnl_matrix_fixed<T,m,n> into this.
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	put (unsigned r, unsigned c, T const &v)
	set element.
T	get (unsigned r, unsigned c) const
	get element.
T *	operator[] (unsigned r)
	return pointer to given row.
T const *	operator[] (unsigned r) const
	return pointer to given row.
T &	operator() (unsigned r, unsigned c)
	Access an element for reading or writing.
T const &	operator() (unsigned r, unsigned c) const
	Access an element for reading.
void	fill (T)
	Set all elements of matrix to specified value.
void	fill_diagonal (T)
	Set all diagonal elements of matrix to specified value.
void	copy_in (T const *)
	Fill (laminate) this matrix with the given data.
void	set (T const *d)
	Fill (laminate) this matrix with the given data.
void	copy_out (T *) const
	Fill the given array with this matrix.
void	inplace_transpose ()
	Transpose this matrix efficiently, if it is a square matrix.
vnl_matrix_fixed &	operator+= (T s)
	Add s to each element of lhs matrix in situ.
vnl_matrix_fixed &	operator-= (T s)
	Subtract s from each element of lhs matrix in situ.
vnl_matrix_fixed &	operator *= (T s)
vnl_matrix_fixed &	operator/= (T s)
vnl_matrix_fixed &	operator+= (vnl_matrix_fixed const &m)
vnl_matrix_fixed &	operator+= (vnl_matrix< T > const &m)
vnl_matrix_fixed &	operator-= (vnl_matrix_fixed const &m)
vnl_matrix_fixed &	operator-= (vnl_matrix< T > const &m)
vnl_matrix_fixed	operator- () const
	Negate all elements of matrix.
vnl_matrix_fixed &	operator *= (vnl_matrix_fixed< T, num_cols, num_cols > const &s)
vnl_matrix_fixed	apply (T(*f)(T)) const
	Make a new matrix by applying function to each element.
vnl_matrix_fixed	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_fixed &	update (vnl_matrix< T > const &, unsigned top=0, unsigned left=0)
	Set values of this matrix to those of M, starting at [top,left].
void	set_column (unsigned i, T const *v)
	Set the elements of the i'th column to v[j] (No bounds checking).
void	set_column (unsigned i, T value)
	Set the elements of the i'th column to value.
void	set_column (unsigned j, vnl_vector< T > const &v)
	Set j-th column to v.
void	set_column (unsigned j, vnl_vector_fixed< T, num_rows > const &v)
	Set j-th column to v.
void	set_columns (unsigned starting_column, vnl_matrix< T > const &M)
	Set columns to those in M, starting at starting_column.
void	set_row (unsigned i, T const *v)
	Set the elements of the i'th row to v[j] (No bounds checking).
void	set_row (unsigned i, T value)
	Set the elements of the i'th row to value.
void	set_row (unsigned i, vnl_vector< T > const &)
	Set the i-th row.
void	set_row (unsigned i, vnl_vector_fixed< T, num_cols > const &)
	Set the i-th row.
vnl_matrix< T >	extract (unsigned r, unsigned c, unsigned top=0, unsigned left=0) const
	Extract a sub-matrix of size r x c, starting at (top,left).
void	extract (vnl_matrix< T > &sub_matrix, unsigned top=0, unsigned left=0) const
	Extract a sub-matrix starting at (top,left).
vnl_vector_fixed< T, num_cols >	get_row (unsigned row) const
	Get a vector equal to the given row.
vnl_vector_fixed< T, num_rows >	get_column (unsigned col) const
	Get a vector equal to the given column.
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.
void	set_identity ()
	Set this matrix to an identity matrix.
void	flipud ()
	Reverse order of rows.
void	fliplr ()
	Reverse order of columns.
void	normalize_rows ()
	Normalize each row so it is a unit vector.
void	normalize_columns ()
	Normalize each column so it is a unit vector.
void	scale_row (unsigned row, T value)
	Scale elements in given row by a factor of T.
void	scale_column (unsigned col, T value)
	Scale elements in given column by a factor of T.
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.
T	min_value () const
	Return minimum value of elements.
T	max_value () const
	Return maximum value of elements.
T	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 nr_rows, unsigned nr_cols) const
	abort if size is not as expected.
void	assert_finite () const
	abort if matrix contains any INFs or NANs.
bool	read_ascii (vcl_istream &s)
T const *	data_block () const
	Access the contiguous block storing the elements in the matrix row-wise. O(1).
T *	data_block ()
	Access the contiguous block storing the elements in the matrix row-wise. O(1).
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 ()
	Iterator pointing to start of data.
iterator	end ()
	Iterator pointing to element beyond end of data.
const_iterator	begin () const
	Iterator pointing to start of data.
const_iterator	end () const
	Iterator pointing to element beyond end of data.
bool	operator_eq (vnl_matrix_fixed const &rhs) const
	Return true if *this == rhs.
bool	operator== (vnl_matrix< T > const &that) const
	Equality operator.
bool	operator!= (vnl_matrix< T > const &that) const
	Inequality operator.
void	print (vcl_ostream &os) const
	Print matrix to os in some hopefully sensible format.
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)
Private Member Functions
void	assert_finite_internal () const
void	assert_size_internal (unsigned, unsigned) const
Private Attributes
T	data_ [num_rows][num_cols]