shawn::RandomizedDistanceEstimate Class Reference

#include <randomized_distance_estimate.h>

Inheritance diagram for shawn::RandomizedDistanceEstimate:

[legend]

Collaboration diagram for shawn::RandomizedDistanceEstimate:

[legend]

List of all members.

Public Member Functions
	RandomizedDistanceEstimate ()
virtual	~RandomizedDistanceEstimate ()
virtual void	set_multiplier (const ConstRandomVariableHandle &) throw ()
virtual void	set_offset (const ConstRandomVariableHandle &) throw ()
virtual void	set_chop_lower (double) throw ()
virtual void	set_resample_chopped (bool) throw ()
virtual void	set_name (const std::string &) throw ()
virtual void	init (void) throw ()
virtual bool	estimate_distance (const Node &source, const Node &target, double &result) const throw ()
virtual std::string	name (void) const throw ()
virtual std::string	description (void) const throw ()

---

Constructor & Destructor Documentation

shawn::RandomizedDistanceEstimate::RandomizedDistanceEstimate

(

)

virtual shawn::RandomizedDistanceEstimate::~RandomizedDistanceEstimate

(

)

[virtual]

---

Member Function Documentation

virtual void shawn::RandomizedDistanceEstimate::set_multiplier

(

const ConstRandomVariableHandle &

)

throw () [virtual]

virtual void shawn::RandomizedDistanceEstimate::set_offset

(

const ConstRandomVariableHandle &

)

throw () [virtual]

virtual void shawn::RandomizedDistanceEstimate::set_chop_lower

(

double

)

throw () [virtual]

virtual void shawn::RandomizedDistanceEstimate::set_resample_chopped

(

bool

)

throw () [virtual]

virtual void shawn::RandomizedDistanceEstimate::set_name

(

const std::string &

)

throw () [virtual]

virtual void shawn::RandomizedDistanceEstimate::init

(

void

)

throw () [virtual]

virtual bool shawn::RandomizedDistanceEstimate::estimate_distance	(	const Node &	source,
		const Node &	target,
		double &	result
	)			const throw () [virtual]

Estimates the distance between two nodes source and target.

Parameters:

	source	The source node for the estimation
	target	The destination node for the estimation
	result	The result of the estimation will be placed here ONLY IF true is returned

Returns:

true if a distance could be estimated between the two nodes, false otherwise

Implements shawn::NodeDistanceEstimate.

virtual std::string shawn::RandomizedDistanceEstimate::name

(

void

)

const throw () [virtual]

Implements shawn::KeeperManaged.

virtual std::string shawn::RandomizedDistanceEstimate::description

(

void

)

const throw () [virtual]

Implements shawn::KeeperManaged.

---

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

• src/sys/distance_estimates/randomized_distance_estimate.h