Bridges-C++  3.1.1
Bridges(C++API)
Classes | Public Member Functions | Protected Attributes | List of all members
bridges::datastructure::Grid< E > Class Template Reference

#include <Grid.h>

Inheritance diagram for bridges::datastructure::Grid< E >:
bridges::datastructure::DataStructure

Detailed Description

template<typename E>
class bridges::datastructure::Grid< E >

This is a class in BRIDGES for representing an (n x n) grid.

This class will be useful in applications such as image processing, board games, etc.

Author
David Burlinson, C++ port Kalpathi Subramanian
Date
7/12/19
Parameters
EThere is a tutorial about Grid : http://bridgesuncc.github.io/tutorials/Grid.html

Classes

class  BracketHelper
 
class  BracketHelperConst
 

Public Member Functions

virtual const string getDStype () const override
 
 Grid (int rows, int cols)
 
 Grid ()
 
 Grid (int *size)
 
 Grid (const Grid &g)
 
virtual ~Grid ()
 
Gridoperator= (const Grid &g)
 
void setDimensions (int rows, int cols)
 
int const * getDimensions ()
 
E const & get (int row, int col) const
 
void set (int row, int col, E val)
 
BracketHelperConst operator[] (int row) const
 provides the necessary abstraction to do something = grid[x][y]; More...
 
BracketHelper operator[] (int row)
 provides the necessary abstraction to do grid[x][y] = something; More...
 
- Public Member Functions inherited from bridges::datastructure::DataStructure
virtual ~DataStructure ()=default
 

Protected Attributes

E ** grid = nullptr
 
int gridSize [2]
 
int maxGridSize [2] = {1080, 1920}
 

Constructor & Destructor Documentation

◆ Grid() [1/4]

template<typename E>
bridges::datastructure::Grid< E >::Grid ( int  rows,
int  cols 
)
inline

Grid constructors

◆ Grid() [2/4]

template<typename E>
bridges::datastructure::Grid< E >::Grid ( )
inline

◆ Grid() [3/4]

template<typename E>
bridges::datastructure::Grid< E >::Grid ( int *  size)
inlineexplicit

◆ Grid() [4/4]

template<typename E>
bridges::datastructure::Grid< E >::Grid ( const Grid< E > &  g)
inline

◆ ~Grid()

template<typename E>
virtual bridges::datastructure::Grid< E >::~Grid ( )
inlinevirtual

Member Function Documentation

◆ get()

template<typename E>
E const& bridges::datastructure::Grid< E >::get ( int  row,
int  col 
) const
inline

◆ getDimensions()

template<typename E>
int const* bridges::datastructure::Grid< E >::getDimensions ( )
inline

◆ getDStype()

template<typename E>
virtual const string bridges::datastructure::Grid< E >::getDStype ( ) const
inlineoverridevirtual
Returns
The string representation of this data structure type

Implements bridges::datastructure::DataStructure.

Reimplemented in bridges::game::GameGrid, and bridges::datastructure::ColorGrid.

◆ operator=()

template<typename E>
Grid& bridges::datastructure::Grid< E >::operator= ( const Grid< E > &  g)
inline

◆ operator[]() [1/2]

template<typename E>
BracketHelperConst bridges::datastructure::Grid< E >::operator[] ( int  row) const
inline

provides the necessary abstraction to do something = grid[x][y];

◆ operator[]() [2/2]

template<typename E>
BracketHelper bridges::datastructure::Grid< E >::operator[] ( int  row)
inline

provides the necessary abstraction to do grid[x][y] = something;

◆ set()

template<typename E>
void bridges::datastructure::Grid< E >::set ( int  row,
int  col,
val 
)
inline

◆ setDimensions()

template<typename E>
void bridges::datastructure::Grid< E >::setDimensions ( int  rows,
int  cols 
)
inline

Member Data Documentation

◆ grid

template<typename E>
E** bridges::datastructure::Grid< E >::grid = nullptr
protected

◆ gridSize

template<typename E>
int bridges::datastructure::Grid< E >::gridSize[2]
protected

◆ maxGridSize

template<typename E>
int bridges::datastructure::Grid< E >::maxGridSize[2] = {1080, 1920}
protected

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