HyperPlot  v1
Bin and visualise multidimensional datasets
Public Member Functions | Protected Attributes | List of all members
NPlane Class Reference

Detailed Description

A NPlane is some subspace of nDimensional space defined by between 1 and nDim HyperPoints. e.g. to 3D space, you could have a point, a line, or a plane (defined by 1, 2 and 3 points respectively)

Definition at line 30 of file NPlane.h.

#include <NPlane.h>

Inheritance diagram for NPlane:
HyperLine HyperPlane

Public Member Functions

 NPlane (const HyperPointSet &a)
 
 NPlane (const HyperPoint &origin, const HyperPointSet &v)
 
int getDimension () const
 
int getN () const
 
const HyperPointgetOrigin () const
 
virtual const HyperPointgetDirection (int i=0) const
 
HyperPoint getParametricPoint (const HyperPoint &t) const
 
virtual void print (std::ostream &os=std::cout, int endline=1) const
 
virtual ~NPlane ()
 

Protected Attributes

HyperPoint _origin
 
HyperPointSet _v
 

Constructor & Destructor Documentation

NPlane::NPlane ( const HyperPointSet a)

Standard constuctor that takes between 1 and nDim HyperPoints. Internally this is converted into an origin and between 0 and (nDim - 1) vectors.

Definition at line 6 of file NPlane.cpp.

NPlane::NPlane ( const HyperPoint origin,
const HyperPointSet v 
)

Constuctor that takes between an origin, and between 0 and (nDim - 1) vectors.

Definition at line 25 of file NPlane.cpp.

NPlane::~NPlane ( )
virtual

Destructor

Definition at line 71 of file NPlane.cpp.

Member Function Documentation

int NPlane::getDimension ( ) const
inline

get the dimensionality

Definition at line 45 of file NPlane.h.

virtual const HyperPoint& NPlane::getDirection ( int  i = 0) const
inlinevirtual

get one of the vectors that defines the NPlane

Definition at line 54 of file NPlane.h.

int NPlane::getN ( ) const
inline

get the number of vectors that define the NPlane

Definition at line 47 of file NPlane.h.

const HyperPoint& NPlane::getOrigin ( ) const
inline

get the origin of the NPlane

Definition at line 51 of file NPlane.h.

HyperPoint NPlane::getParametricPoint ( const HyperPoint t) const

The subspace is defined by (O + x.v_1 + y.v_2 + z.v_3 ...) - a point in this space is then defined by the `ParametricPoint' (x,y,z...). This function takes (x,y,z...) and returns (O + x.v_1 + y.v_2 + z.v_3 ...)

Definition at line 40 of file NPlane.cpp.

void NPlane::print ( std::ostream &  os = std::cout,
int  endline = 1 
) const
virtual

Print out the origin and vectors that define the NPlane

Reimplemented in HyperPlane, and HyperLine.

Definition at line 56 of file NPlane.cpp.

Member Data Documentation

HyperPoint NPlane::_origin
protected

The origin of the subspace

Definition at line 34 of file NPlane.h.

HyperPointSet NPlane::_v
protected

The vectors that define the dimensionality of the subspace

Definition at line 36 of file NPlane.h.


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