SynAPSE  0.6.0
Synergistic Analysis of Phase Space Evolution
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
Public Member Functions | Private Attributes
LocalReachability Class Reference

Computes the Local Reachability density estimator of a set of points. More...

#include <LocalReachability.hh>

Public Member Functions

 LocalReachability ()
 Default constructor, initilizes everything to 0. More...
 
 LocalReachability (const std::vector< std::vector< double >> &points, const size_t k)
 Normal constructor, fills the cloud with the provided points. More...
 
 LocalReachability (const LocalReachability &lr)
 Copy constructor. More...
 
LocalReachability & operator= (const LocalReachability &lr)
 Equality operator. More...
 
double operator() (const std::vector< double > &v) const
 Overloaded function operator, calls Evaluate. More...
 
double operator() (const double &v) const
 Overloaded function operator, calls Evaluate. More...
 
double operator() (const double *v) const
 Overloaded function operator, calls Evaluate. More...
 
 ~LocalReachability ()
 Destructor. More...
 
void Initialize ()
 Checks that the input is sensible. More...
 
double Evaluate (const std::vector< double > &v) const
 Performs the density estimation at an n-point v. More...
 
double Evaluate (const double &v) const
 Performs the density estimation at an n-point v. More...
 
double Evaluate (const double *v) const
 Performs the density estimation at an n-point v. More...
 
const size_t & GetDimension () const
 Returns the dimension of the space. More...
 
double Distance (const std::vector< double > &A, const std::vector< double > &B) const
 Returns the the distance between a point A and a point B. More...
 
double KDistance (const std::vector< double > &A) const
 Returns the distance to the k^th NN of a point A. More...
 
double RDistance (const std::vector< double > &A, const std::vector< double > &B) const
 Returns the the reachability distance of a point A by a point B. More...
 
double RVolume (const double &radius) const
 Returns the volume of the hypersphere that contains of reachability radius. More...
 
double RDensity (const std::vector< double > &A) const
 Returns the the local reachability density of a point A. More...
 

Private Attributes

size_t _dim
 Dimension of the space. More...
 
std::vector< std::vector
< double > > 
_points
 Cloud of points. More...
 
size_t _k
 Number of neighbours to consider. More...
 
KDTree * _kdtree
 k-d Tree of the points to find NNs More...
 

Detailed Description

Computes the Local Reachability density estimator of a set of points.

Computes reachability of the of the sample point by the cloud and its corresponding density

Constructor & Destructor Documentation

LocalReachability::LocalReachability ( )

Default constructor, initilizes everything to 0.

LocalReachability::LocalReachability ( const std::vector< std::vector< double >> &  points,
const size_t  k 
)

Normal constructor, fills the cloud with the provided points.

Parameters
pointsVector of points
kNumber of neighbours to probe
LocalReachability::LocalReachability ( const LocalReachability &  lr)

Copy constructor.

LocalReachability::~LocalReachability ( )

Destructor.

Member Function Documentation

double LocalReachability::Distance ( const std::vector< double > &  A,
const std::vector< double > &  B 
) const

Returns the the distance between a point A and a point B.

double LocalReachability::Evaluate ( const std::vector< double > &  v) const
inline

Performs the density estimation at an n-point v.

Parameters
vVector of coordinates of the n-point
double LocalReachability::Evaluate ( const double &  v) const

Performs the density estimation at an n-point v.

Parameters
vOne dimensional value of the point
double LocalReachability::Evaluate ( const double *  v) const

Performs the density estimation at an n-point v.

Parameters
vPointer to an array of coordinates of the n-point
const size_t& LocalReachability::GetDimension ( ) const
inline

Returns the dimension of the space.

void LocalReachability::Initialize ( )

Checks that the input is sensible.

double LocalReachability::KDistance ( const std::vector< double > &  A) const

Returns the distance to the k^th NN of a point A.

double LocalReachability::operator() ( const std::vector< double > &  v) const
inline

Overloaded function operator, calls Evaluate.

Parameters
vVector of coordinates
double LocalReachability::operator() ( const double &  v) const
inline

Overloaded function operator, calls Evaluate.

Parameters
vOne dimensional value
double LocalReachability::operator() ( const double *  v) const
inline

Overloaded function operator, calls Evaluate.

Parameters
vPointer to an array of coordinates
LocalReachability & LocalReachability::operator= ( const LocalReachability &  lr)

Equality operator.

double LocalReachability::RDensity ( const std::vector< double > &  A) const

Returns the the local reachability density of a point A.

double LocalReachability::RDistance ( const std::vector< double > &  A,
const std::vector< double > &  B 
) const

Returns the the reachability distance of a point A by a point B.

double LocalReachability::RVolume ( const double &  radius) const

Returns the volume of the hypersphere that contains of reachability radius.

Field Documentation

size_t LocalReachability::_dim
private

Dimension of the space.

size_t LocalReachability::_k
private

Number of neighbours to consider.

KDTree* LocalReachability::_kdtree
private

k-d Tree of the points to find NNs

std::vector<std::vector<double> > LocalReachability::_points
private

Cloud of points.


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