gstlrn::Ball Class Reference

#include <Ball.hpp>

Public Member Functions
	Ball ()=default
	Ball (const Db *dbin, const Db *dbout=nullptr, Id leaf_size=10, bool all_available=true, Id default_distance_function=1, bool useSel=false)
	Construct a new Ball tree object.
	Ball (const AMesh *mesh, Id leaf_size=10, bool all_available=true, Id default_distance_function=1)
	Construct a new Ball tree object based on the barycenters of the meshes.
void	init (const Db *db, Id leaf_size=10, bool all_available=true, Id default_distance_function=1, bool useSel=false)
	Construct a new Ball tree object.
KNN	queryAsVVD (const 1 &test, Id n_neighbors=1)
KNN	queryOne (const double *test, Id n_features, Id n_neighbors=1)
KNN	queryOneAsVD (const 1 &test, Id n_neighbors=1)
KNN	queryOneAsVDFromSP (const SpacePoint &Pt, Id n_neighbors=1)
	getIndices (const SpacePoint &Pt, Id n_neighbors=1)
Id	queryClosest (const 1 &test)
Id	queryOneInPlace (const 1 &test, Id n_neighbors, 1 &indices, 1 &distances, Id rank=0)
void	display (Id level=-1) const
	Ask for information regarding the Ball Tree organization.
Id	setAvailable (Id rank, bool status)
Id	resetAvailable (bool status)
bool	empty () const

Constructor & Destructor Documentation

Ball() [1/3]

gstlrn::Ball::Ball ( )

default

Ball() [2/3]

gstlrn::Ball::Ball	(	const Db *	dbin,
		const Db *	dbout = nullptr,
		Id	leaf_size = 10,
		bool	all_available = true,
		Id	default_distance_function = 1,
		bool	useSel = false
	)

Construct a new Ball tree object.

Parameters

dbin	Input database
dbout	Output database (appended to input) (can be null)
leaf_size	Number of elements in the leafs of the Ball tree
all_available	True if samples are available for selection at the beginning (True by default)
default_distance_function	1 for Euclidean distance, 2 for Manhattan
useSel	True if only the selected samples of dbin are used to build the Ball tree

Ball() [3/3]

gstlrn::Ball::Ball	(	const AMesh *	mesh,
		Id	leaf_size = 10,
		bool	all_available = true,
		Id	default_distance_function = 1
	)

Construct a new Ball tree object based on the barycenters of the meshes.

Parameters

mesh	AMesh description
leaf_size	Number of elements in the leafs of the Ball tree
all_available	True if samples are available for selection at the beginning
default_distance_function	1 for Euclidean distance, 2 for Manhattan

Member Function Documentation

display()

void gstlrn::Ball::display

(

Id

level = -1

)

const

Ask for information regarding the Ball Tree organization.

Parameters

level

Level of details -1 Just the general volumetry information 0 List of the different nodes 1 List of Leaves and attached list of samples

empty()

bool gstlrn::Ball::empty ( ) const

inline

getIndices()

gstlrn::Ball::getIndices	(	const SpacePoint &	Pt,
		Id	n_neighbors = 1
	)

init()

void gstlrn::Ball::init	(	const Db *	db,
		Id	leaf_size = 10,
		bool	all_available = true,
		Id	default_distance_function = 1,
		bool	useSel = false
	)

Construct a new Ball tree object.

Parameters

db	Input database
leaf_size	Number of elements in the leafs of the Ball tree
all_available	True if samples are available for selection at the beginning (True by default)
default_distance_function	1 for Euclidean distance, 2 for Manhattan
useSel	True if only the selected samples of dbin are used to build the Ball tree

queryAsVVD()

KNN gstlrn::Ball::queryAsVVD	(	const 1 &	test,
		Id	n_neighbors = 1
	)

queryClosest()

Id gstlrn::Ball::queryClosest

(

const 1 &

test

)

queryOne()

KNN gstlrn::Ball::queryOne	(	const double *	test,
		Id	n_features,
		Id	n_neighbors = 1
	)

queryOneAsVD()

KNN gstlrn::Ball::queryOneAsVD	(	const 1 &	test,
		Id	n_neighbors = 1
	)

queryOneAsVDFromSP()

KNN gstlrn::Ball::queryOneAsVDFromSP	(	const SpacePoint &	Pt,
		Id	n_neighbors = 1
	)

queryOneInPlace()

Id gstlrn::Ball::queryOneInPlace	(	const 1 &	test,
		Id	n_neighbors,
		1 &	indices,
		1 &	distances,
		Id	rank = 0
	)

resetAvailable()

Id gstlrn::Ball::resetAvailable

(

bool

status

)

setAvailable()

Id gstlrn::Ball::setAvailable	(	Id	rank,
		bool	status
	)

---

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

• include/Tree/Ball.hpp
• src/Tree/Ball.cpp