karto::Matrix Class Reference

#include <Karto.h>

List of all members.

Public Member Functions
void	Clear ()
kt_int32u	GetColumns () const
kt_int32u	GetRows () const
	Matrix (kt_int32u rows, kt_int32u columns)
const kt_double &	operator() (kt_int32u row, kt_int32u column) const
kt_double &	operator() (kt_int32u row, kt_int32u column)
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 2511 of file Karto.h.

---

Constructor & Destructor Documentation

karto::Matrix::Matrix	(	kt_int32u	rows,
		kt_int32u	columns
	)			[inline]

Constructs a matrix of size rows x columns

Definition at line 2517 of file Karto.h.

virtual karto::Matrix::~Matrix

(

)

[inline, virtual]

Destructor

Definition at line 2530 of file Karto.h.

---

Member Function Documentation

void karto::Matrix::Allocate

(

)

[inline, private]

Allocate space for the matrix

Definition at line 2595 of file Karto.h.

void karto::Matrix::Clear

(

)

[inline]

Set all entries to 0

Definition at line 2539 of file Karto.h.

kt_int32u karto::Matrix::GetColumns

(

)

const [inline]

Gets the number of columns of the matrix

Returns:

nubmer of columns

Definition at line 2560 of file Karto.h.

kt_int32u karto::Matrix::GetRows

(

)

const [inline]

Gets the number of rows of the matrix

Returns:

nubmer of rows

Definition at line 2551 of file Karto.h.

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 2584 of file Karto.h.

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 2571 of file Karto.h.

void karto::Matrix::RangeCheck	(	kt_int32u	row,
		kt_int32u	column
	)			const [inline, private]

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

Parameters:

	row
	column

Definition at line 2622 of file Karto.h.

---

Member Data Documentation

kt_int32u karto::Matrix::m_Columns [private]

Definition at line 2637 of file Karto.h.

kt_double* karto::Matrix::m_pData [private]

Definition at line 2639 of file Karto.h.

kt_int32u karto::Matrix::m_Rows [private]

Definition at line 2636 of file Karto.h.

---

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

• Karto.h