MP5
Photomosaic
 All Classes Namespaces Files Functions Variables Pages
Point< Dim > Class Template Reference

Point class: represents a point in Dim dimensional space. More...

#include <point.h>

Collaboration diagram for Point< Dim >:
[legend]

Classes

class  MineAction
 
class  MineAction_DoNothingImpl
 

Public Member Functions

 Point (double arr[Dim])
 
template<typename T >
 Point (T x,...)
 
template<typename T >
 Point (T x0, T x1, T x2)
 
Pointoperator= (const Point &other)
 
double operator[] (int index) const
 Gets the value of the Point object in the given dimension (index). More...
 
double & operator[] (int index)
 Gets the value of the Point object in the given dimension (index). More...
 
bool operator== (const Point< Dim > p) const
 
bool operator!= (const Point< Dim > p) const
 
bool operator< (const Point< Dim > p) const
 Compares whether the given Point is smaller than the current Point. More...
 
bool operator<= (const Point< Dim > p) const
 
bool operator> (const Point< Dim > p) const
 
bool operator>= (const Point< Dim > p) const
 
void set (int index, double val)
 
void print (std::ostream &out=std::cout) const
 
bool isMine () const
 
 Point (double arr[Dim], bool isMine, const MineAction *mineAction)
 

Private Attributes

double vals [Dim]
 
bool isMine_ = false
 
MineAction_DoNothingImpl MineAction_DoNothing
 
const MineActionmineAction_ = &MineAction_DoNothing
 

Detailed Description

template<int Dim>
class Point< Dim >

Point class: represents a point in Dim dimensional space.

Author
Matt Sachtler
Date
Spring 2009

Member Function Documentation

template<int Dim>
bool Point< Dim >::operator< ( const Point< Dim >  p) const

Compares whether the given Point is smaller than the current Point.

Parameters
pThe other point to compare with.
Returns
A boolean value indicating whether the current Point is smaller than the provided Point p.
template<int Dim>
double Point< Dim >::operator[] ( int  index) const

Gets the value of the Point object in the given dimension (index).

This function is const so we don't modify Points using this function.

Parameters
indexThe dimension of the Point to grab.
Returns
The value of the Point in the indexth dimension.
template<int Dim>
double & Point< Dim >::operator[] ( int  index)

Gets the value of the Point object in the given dimension (index).

This is the non-const version, so it can be used to modify Points like so:

Point<3> a(1, 2, 3);
a[0] = 4; // a is now (4, 2, 3)
Parameters
indexThe dimension of the Point to grab.
Returns
The value of the Point in the indexth dimension, by reference (so that it may be modified).

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