karto::Matrix Class Reference

#include <Karto.h>

Public Member Functions
void	Clear ()
kt_int32u	GetColumns () const
kt_int32u	GetRows () const
	Matrix (kt_int32u rows, kt_int32u columns)
kt_double &	operator() (kt_int32u row, kt_int32u column)
const kt_double &	operator() (kt_int32u row, kt_int32u column) const
virtual	~Matrix ()

Private Member Functions
void	Allocate ()
void	RangeCheck (kt_int32u row, kt_int32u column) const

Private Attributes
kt_int32u	m_Columns
kt_double *	m_pData
kt_int32u	m_Rows

Detailed Description

Defines a general Matrix class.

Definition at line 2731 of file Karto.h.

Constructor & Destructor Documentation

Matrix()

karto::Matrix::Matrix ( kt_int32u  rows, kt_int32u  columns  )

inline

Constructs a matrix of size rows x columns

Definition at line 2737 of file Karto.h.

~Matrix()

virtual karto::Matrix::~Matrix ( )

inlinevirtual

Destructor

Definition at line 2750 of file Karto.h.

Member Function Documentation

Allocate()

void karto::Matrix::Allocate ( )

inlineprivate

Allocate space for the matrix

Definition at line 2815 of file Karto.h.

Clear()

void karto::Matrix::Clear ( )

inline

Set all entries to 0

Definition at line 2759 of file Karto.h.

GetColumns()

kt_int32u karto::Matrix::GetColumns ( ) const

inline

Gets the number of columns of the matrix

Returns

nubmer of columns

Definition at line 2780 of file Karto.h.

GetRows()

kt_int32u karto::Matrix::GetRows ( ) const

inline

Gets the number of rows of the matrix

Returns

nubmer of rows

Definition at line 2771 of file Karto.h.

operator()() [1/2]

kt_double& karto::Matrix::operator() ( kt_int32u  row, kt_int32u  column  )

inline

Returns a reference to the entry at (row,column)

Parameters

row
column

Returns

reference to entry at (row,column)

Definition at line 2791 of file Karto.h.

operator()() [2/2]

const kt_double& karto::Matrix::operator() ( kt_int32u  row, kt_int32u  column  ) const

inline

Returns a const reference to the entry at (row,column)

Parameters

row
column

Returns

const reference to entry at (row,column)

Definition at line 2804 of file Karto.h.

RangeCheck()

void karto::Matrix::RangeCheck ( kt_int32u  row, kt_int32u  column  ) const

inlineprivate

Checks if (row,column) is a valid entry into the matrix

Parameters

row
column

Definition at line 2842 of file Karto.h.

Member Data Documentation

m_Columns

kt_int32u karto::Matrix::m_Columns

private

Definition at line 2857 of file Karto.h.

m_pData

kt_double* karto::Matrix::m_pData

private

Definition at line 2859 of file Karto.h.

m_Rows

kt_int32u karto::Matrix::m_Rows

private

Definition at line 2856 of file Karto.h.

---

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

• Karto.h