cluster::Cluster< F > Class Template Reference

#include <tree.hh>

Public Types
typedef F	CF
	Typedef used for interface (trait) of the cluster tree.

Public Member Functions
	Cluster (const concepts::Element< F > &elm, const BBall< F > &ball, Cluster< F > *lnk)
	Cluster (uint idx, Cluster< F > &chld, const concepts::Real3d &c, concepts::Real r, uint nlf=0)
Cluster< F > *	child (uint j) const
	j-th child of the cluster if the cluster is not a leaf
Cluster< F > *	child () const
	First child of the cluster if the cluster is not a leaf.
Cluster< F > *	link () const
	Neighbouring cluster.
Cluster< F > *&	link ()
const concepts::Element< F > *	element () const
	Returns element if the cluster is a leaf.
const concepts::Real3d &	center () const
	Center of the cluster.
concepts::Real	radius () const
	Radius of the cluster.
uint	nleaf () const
	Number of leafs of the cluster.
uint	index () const
	Index (number) of the cluster.
std::ostream &	info (std::ostream &os) const

Friends
std::ostream &	operator<< (std::ostream &os, const Cluster< F > &clst)

Detailed Description

template<class F>
class cluster::Cluster< F >

Node of a cluster tree

Parameters

F	Field (Real or Cmplx)

Definition at line 129 of file tree.hh.

Member Typedef Documentation

CF

template<class F >

typedef F cluster::Cluster< F >::CF

Typedef used for interface (trait) of the cluster tree.

Definition at line 132 of file tree.hh.

Constructor & Destructor Documentation

Cluster() [1/2]

template<class F >

cluster::Cluster< F >::Cluster	(	const concepts::Element< F > &	elm,
		const BBall< F > &	ball,
		Cluster< F > *	lnk
	)

Constructor if Cluster is a leaf in the tree.

Parameters

elm	Element
ball	Bounding ball for the element
lnk	Neighbouring cluster

Definition at line 230 of file tree.hh.

Cluster() [2/2]

template<class F >

cluster::Cluster< F >::Cluster	(	uint	idx,
		Cluster< F > &	chld,
		const concepts::Real3d &	c,
		concepts::Real	r,
		uint	nlf = 0
	)

Constructor if Cluster is not a leaf in the tree.

Parameters

idx	Cluster number
chld	Pointer to the linked list of children
c	Cluster center
r	Cluster radius
nlf	Number of leafs contained in the cluster

Definition at line 218 of file tree.hh.

Member Function Documentation

center()

template<class F >

const concepts::Real3d & cluster::Cluster< F >::center ( ) const

inline

Center of the cluster.

Definition at line 161 of file tree.hh.

child() [1/2]

template<class F >

Cluster< F > * cluster::Cluster< F >::child ( ) const

inline

First child of the cluster if the cluster is not a leaf.

Definition at line 203 of file tree.hh.

child() [2/2]

template<class F >

Cluster< F > * cluster::Cluster< F >::child ( uint  j ) const

inline

j-th child of the cluster if the cluster is not a leaf

Definition at line 196 of file tree.hh.

element()

template<class F >

const concepts::Element< F > * cluster::Cluster< F >::element ( ) const

inline

Returns element if the cluster is a leaf.

Definition at line 208 of file tree.hh.

index()

template<class F >

uint cluster::Cluster< F >::index ( ) const

inline

Index (number) of the cluster.

Definition at line 167 of file tree.hh.

info()

template<class F >

std::ostream & cluster::Cluster< F >::info

(

std::ostream &

os

)

const

Definition at line 239 of file tree.hh.

link() [1/2]

template<class F >

Cluster< F > *& cluster::Cluster< F >::link ( )

inline

Definition at line 157 of file tree.hh.

link() [2/2]

template<class F >

Cluster< F > * cluster::Cluster< F >::link ( ) const

inline

Neighbouring cluster.

Definition at line 156 of file tree.hh.

nleaf()

template<class F >

uint cluster::Cluster< F >::nleaf ( ) const

inline

Number of leafs of the cluster.

Definition at line 165 of file tree.hh.

radius()

template<class F >

concepts::Real cluster::Cluster< F >::radius ( ) const

inline

Radius of the cluster.

Definition at line 163 of file tree.hh.

Friends And Related Symbol Documentation

operator<<

template<class F >

std::ostream & operator<< ( std::ostream &  os, const Cluster< F > &  clst  )

friend

Definition at line 213 of file tree.hh.

---

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

• cluster/tree.hh