SkelCL
SkelCL is a high level multi GPU skeleton library developed at the university of M√ľnster, Germany.
 All Classes Namespaces Files Functions Variables Typedefs Groups
Public Types | Public Member Functions | List of all members
skelcl::MatrixSize Class Reference

This class defines a two dimensional size for a Matrix. More...

#include <Matrix.h>

Public Types

typedef size_t size_type
 

Public Member Functions

 MatrixSize (size_type rowCount, size_type columnCount)
 Create a new MatrixSize object with the given number of rows and number of columns. More...
 
size_type elemCount () const
 Returns the total number of elements. I.e. rowCount() * columnCount(). More...
 
size_type rowCount () const
 Returns the number of rows. More...
 
size_type columnCount () const
 Returns the number of columns. More...
 
bool operator== (const MatrixSize &rhs) const
 Compares two MatrixSizes for equality. More...
 
bool operator!= (const MatrixSize &rhs) const
 Compares two MatrixSizes for inequality. More...
 
bool operator> (const MatrixSize &rhs) const
 Compares if this is greater than rhs. More...
 
bool operator< (const MatrixSize &rhs) const
 Compares if this is less than rhs. More...
 
bool operator>= (const MatrixSize &rhs) const
 Compares if this is greater than rhs. More...
 
bool operator<= (const MatrixSize &rhs) const
 Compares if this is less than rhs. More...
 

Detailed Description

This class defines a two dimensional size for a Matrix.

The number of rows and the number of columns are stored. Objects of this type can be compared against each other.

Definition at line 67 of file Matrix.h.

Constructor & Destructor Documentation

skelcl::MatrixSize::MatrixSize ( size_type  rowCount,
size_type  columnCount 
)

Create a new MatrixSize object with the given number of rows and number of columns.

Parameters
rowCountThe number of rows.
columnCountThe number of columns.

Definition at line 46 of file MatrixSize.cpp.

Member Function Documentation

MatrixSize::size_type skelcl::MatrixSize::columnCount ( ) const

Returns the number of columns.

Returns
The number of columns.

Definition at line 61 of file MatrixSize.cpp.

MatrixSize::size_type skelcl::MatrixSize::elemCount ( ) const

Returns the total number of elements. I.e. rowCount() * columnCount().

Returns
rowCount() * columnCount()

Definition at line 51 of file MatrixSize.cpp.

bool skelcl::MatrixSize::operator!= ( const MatrixSize rhs) const

Compares two MatrixSizes for inequality.

Parameters
rhsThe MatrixSize to compare with.
Returns
Returns !(this == rhs)

Definition at line 72 of file MatrixSize.cpp.

bool skelcl::MatrixSize::operator< ( const MatrixSize rhs) const

Compares if this is less than rhs.

Parameters
rhsThe MatrixSize to compare with.
Returns
Returns true if columnCount() is equal for this and rhs and rowCount() for this is less than for rhs. Returns also true if columnCount() for this is less than for rhs and rowCount() for this is less or equal than for rhs. Return false otherwise.

Definition at line 90 of file MatrixSize.cpp.

bool skelcl::MatrixSize::operator<= ( const MatrixSize rhs) const

Compares if this is less than rhs.

Parameters
rhsThe MatrixSize to compare with.
Returns
Returns true if columnCount() is equal for this and rhs and rowCount() for this is less or equal than for rhs. Returns also true if columnCount() for this is less than for rhs and rowCount() for this is less or equal than for rhs. Return false otherwise.

Definition at line 116 of file MatrixSize.cpp.

bool skelcl::MatrixSize::operator== ( const MatrixSize rhs) const

Compares two MatrixSizes for equality.

Parameters
rhsThe MatrixSize to compare with.
Returns
Returns true if and only if rowCount() is equal for this and rhs and columnCount() is equal for this and rhs.

Definition at line 66 of file MatrixSize.cpp.

bool skelcl::MatrixSize::operator> ( const MatrixSize rhs) const

Compares if this is greater than rhs.

Parameters
rhsThe MatrixSize to compare with.
Returns
Returns true if columnCount() is equal for this and rhs and rowCount() for this is greater than for rhs. Returns also true if columnCount() for this is greater than for rhs and rowCount() for this is greater or equal than for rhs. Returns false otherwise.

Definition at line 77 of file MatrixSize.cpp.

bool skelcl::MatrixSize::operator>= ( const MatrixSize rhs) const

Compares if this is greater than rhs.

Parameters
rhsThe MatrixSize to compare with.
Returns
Returns true if columnCount() is equal for this and rhs and rowCount() for this is greater or equal than for rhs. Returns also true if columnCount() for this is greater than for rhs and rowCount() for this is greater or equal than for rhs. Returns false otherwise.

Definition at line 103 of file MatrixSize.cpp.

MatrixSize::size_type skelcl::MatrixSize::rowCount ( ) const

Returns the number of rows.

Returns
The number of rows.

Definition at line 56 of file MatrixSize.cpp.


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