#include <include/EST_DMatrix.h>

Inheritance diagram for EST_DMatrix:

Collaboration diagram for EST_DMatrix:

Public Member Functions
	EST_DMatrix (int m, int n)
	size constructor

	EST_DMatrix (const EST_DMatrix &a)
	copy constructor

	EST_DMatrix (const EST_DMatrix &a, int b)
	CHECK - what does this do???

	EST_DMatrix ()
	default constructor

EST_write_status	save (const EST_String &filename, const EST_String &type=EST_DMatrix::default_file_type)
	Save in file (ascii or binary)

EST_read_status	load (const EST_String &filename)
	Load from file (ascii or binary as defined in file)

EST_write_status	est_save (const EST_String &filename, const EST_String &type)
	Save in file in est format.

EST_read_status	est_load (const EST_String &filename)
	Load from file in est format (binary/ascii defined in file itself)

void	copyin (double **x, int rows, int cols)
	Copy 2-d array { x} of size { rows x cols} into matrix.

EST_DMatrix &	operator+= (const EST_DMatrix &a)
	Add elements of 2 same sized matrices.

EST_DMatrix &	operator-= (const EST_DMatrix &a)
	Subtract elements of 2 same sized matrices.

EST_DMatrix &	operator*= (const double f)
	elementwise multiply by scalar

EST_DMatrix &	operator/= (const double f)
	elementwise divide by scalar

Public Member Functions inherited from EST_TSimpleMatrix< double >
	EST_TSimpleMatrix (void)
	default constructor

	EST_TSimpleMatrix (int m, int n)
	size constructor

	EST_TSimpleMatrix (const EST_TSimpleMatrix< double > &m)
	copy constructor

void	copy (const EST_TSimpleMatrix< double > &a)
	copy one matrix into another

void	resize (int rows, int cols, int set=1)
	resize matrix

EST_TSimpleMatrix< double > &	operator= (const EST_TSimpleMatrix< double > &s)
	assignment operator

Public Member Functions inherited from EST_TMatrix< double >
	EST_TMatrix ()
	default constructor

	EST_TMatrix (const EST_TMatrix< double > &m)
	copy constructor

	EST_TMatrix (int rows, int cols)
	"size" constructor

	EST_TMatrix (int rows, int cols, double *memory, int offset=0, int free_when_destroyed=0)
	construct from memory supplied by caller

	~EST_TMatrix ()
	EST_TMatrix.

bool	have_rows_before (int n) const

bool	have_columns_before (int n) const

void	resize (int rows, int cols, int set=1)

void	fill (const double &v)
	fill matrix with value v

void	fill ()

EST_TMatrix &	operator= (const EST_TMatrix &s)
	assignment operator

EST_TMatrix &	add_rows (const EST_TMatrix &s)
	The two versions of what might have been operator +=.

EST_TMatrix &	add_columns (const EST_TMatrix &s)

int	num_rows () const
	return number of rows

int	num_columns () const
	return number of columns

INLINE const double &	a_no_check (int row, int col) const
	const access with no bounds check, care recommend

INLINE double &	a_no_check (int row, int col)
	access with no bounds check, care recommend

INLINE const double &	a_no_check_1 (int row, int col) const

INLINE double &	a_no_check_1 (int row, int col)

const double &	a_check (int row, int col) const
	const element access function

double &	a_check (int row, int col)
	non-const element access function

const double &	a (int row, int col) const

double &	a (int row, int col)

const double &	operator() (int row, int col) const
	const element access operator

double &	operator() (int row, int col)
	non-const element access operator

void	row (EST_TVector< double > &rv, int r, int start_c=0, int len=-1)
	Make the vector { rv} a window onto row { r}.

void	column (EST_TVector< double > &cv, int c, int start_r=0, int len=-1)
	Make the vector { cv} a window onto column { c}.

void	sub_matrix (EST_TMatrix< double > &sm, int r=0, int numr=EST_ALL, int c=0, int numc=EST_ALL)
	Make the matrix { sm} a window into this matrix.

void	copy_row (int r, double *buf, int offset=0, int num=-1) const

void	copy_row (int r, EST_TVector< double > &t, int offset=0, int num=-1) const

void	copy_column (int c, double *buf, int offset=0, int num=-1) const

void	copy_column (int c, EST_TVector< double > &t, int offset=0, int num=-1) const

void	set_row (int n, const double *buf, int offset=0, int num=-1)

void	set_row (int n, const EST_TVector< double > &t, int offset=0, int num=-1)

void	set_row (int r, const EST_TMatrix< double > &from, int from_r, int from_offset=0, int offset=0, int num=-1)

void	set_column (int n, const double *buf, int offset=0, int num=-1)

void	set_column (int n, const EST_TVector< double > &t, int offset=0, int num=-1)

void	set_column (int c, const EST_TMatrix< double > &from, int from_c, int from_offset=0, int offset=0, int num=-1)

void	set_memory (double *buffer, int offset, int rows, int columns, int free_when_destroyed=0)

EST_read_status	load (const class EST_String &filename)
	load Matrix from file - Not currently implemented.

EST_write_status	save (const class EST_String &filename) const
	save Matrix to file { filename}

Public Member Functions inherited from EST_TVector< double >
INLINE unsigned int	vcell_pos (unsigned int c, unsigned int cs) const
	The memory access rule, in one place for easy reference.

INLINE unsigned int	vcell_pos (unsigned int c) const

INLINE unsigned int	vcell_pos_1 (unsigned int c) const

INLINE const double &	fast_a_v (int c) const
	quick method for returning (x[n])

INLINE double &	fast_a_v (int c)

INLINE const double &	fast_a_1 (int c) const

INLINE double &	fast_a_1 (int c)

void	set_values (const double *data, int step, int start_c, int num_c)
	Get and set values from array.

void	get_values (double *data, int step, int start_c, int num_c) const

void	copy (const EST_TVector< double > &a)
	private copy function, called from all other copying functions.

void	copy_data (const EST_TVector< double > &a)
	just copy data, no resizing, no size check.

void	just_resize (int new_cols, double **old_vals)
	resize the memory and reset the bounds, but don't set values.

void	default_vals ()
	sets data and length to default values (0 in both cases).

	EST_TVector ()
	default constructor

	EST_TVector (const EST_TVector< double > &v)
	copy constructor

	EST_TVector (int n)
	"size" constructor - make vector of size n.

	EST_TVector (int, double *memory, int offset=0, int free_when_destroyed=0)
	construct from memory supplied by caller

	~EST_TVector ()
	destructor.

void	resize (int n, int set=1)

const double *	memory () const

double *	memory ()

void	set_memory (double *buffer, int offset, int columns, int free_when_destroyed=0)

EST_TVector &	operator= (const EST_TVector &s)
	assignment operator

void	fill (const double &v)
	Fill entire array will value <parameter>v</parameter>.

void	empty ()
	Fill vector with default value.

int	operator== (const EST_TVector &v) const
	is true if vectors are equal size and all elements are equal.

int	operator!= (const EST_TVector &v) const
	is true if vectors are not equal size or a single elements isn't equal.

void	copy_section (double *dest, int offset=0, int num=-1) const
	Copy data in and out. Subclassed by SimpleVector for speed.

void	set_section (const double *src, int offset=0, int num=-1)

void	sub_vector (EST_TVector< double > &sv, int start_c=0, int len=-1)
	Create a sub vector.

void	integrity () const

INLINE int	num_columns () const
	number of items in vector.

INLINE int	length () const
	number of items in vector.

INLINE int	n () const
	number of items in vector.

INLINE const double &	a_no_check (int n) const
	read-only const access operator: without bounds checking

INLINE double &	a_no_check (int n)
	read/write non-const access operator: without bounds checking

INLINE const double &	a_no_check_1 (int n) const
	read-only const access operator: without bounds checking

INLINE double &	a_no_check_1 (int n)
	read/write non-const access operator: without bounds checking

const double &	a_check (int n) const
	read-only const access operator: with bounds checking

double &	a_check (int n)
	read/write non-const access operator: with bounds checking

const double &	a (int n) const

double &	a (int n)

const double &	operator() (int n) const
	read-only const access operator: return reference to nth member

double &	operator[] (int n)
	read/write non const access operator: return reference to nth member

Static Public Attributes
static EST_String	default_file_type = "est_ascii"

Friends
EST_DMatrix	operator* (const EST_DMatrix &a, const double x)
	Multiply all elements of matrix by { x}.

EST_DVector	operator* (const EST_DMatrix &a, const EST_DVector &v)
	Multiply matrix by vector.

EST_DVector	operator* (const EST_DVector &v, const EST_DMatrix &a)
	Multiply vector by matrix.

EST_DMatrix	operator* (const EST_DMatrix &a, const EST_DMatrix &b)
	Multiply matrix by matrix.

Additional Inherited Members
Public Attributes inherited from EST_TVector< double >
double *	p_memory

unsigned int	p_num_columns
	Visible shape.

unsigned int	p_offset
	How to access the memory.

unsigned int	p_column_step

bool	p_sub_matrix

Protected Member Functions inherited from EST_TSimpleMatrix< double >
void	copy_data (const EST_TSimpleMatrix< double > &a)

Protected Attributes inherited from EST_TMatrix< double >
unsigned int	p_num_rows
	Visible shape.

unsigned int	p_row_step
	How to access the memory.

Detailed Description

A matrix class for double precision floating point numbers.

EST_DMatrix x should be used instead of double **x wherever possible.

Definition at line 54 of file EST_DMatrix.h.

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

include/EST_DMatrix.h
base_class/EST_DMatrix.cc

Public Member Functions

Static Public Attributes

Friends

Additional Inherited Members

Detailed Description