ConnectionDecisionPredicate Class Reference

Binary predicate to decide on a connection between an object from a source population and an object in the destination population. More...

#include <ConnectionDecisionPredicate.h>

Inheritance diagram for ConnectionDecisionPredicate:

[legend]

List of all members.

Public Member Functions
virtual void	init (SimObjectPopulation const &src, SimObjectPopulation const &dst, RandomEngine *rnd)=0
	This function will be called to tell the decision predicate about the source and destination poulation.
virtual bool	decide (size_t src, size_t dst, RandomEngine *rnd)=0
	This function will be called to decide whether to make a connection or not.
virtual	~ConnectionDecisionPredicate ()
	Destruct me.

---

Detailed Description

Binary predicate to decide on a connection between an object from a source population and an object in the destination population.

See also:

PredicateBasedConnections

Definition at line 20 of file ConnectionDecisionPredicate.h.

---

Constructor & Destructor Documentation

virtual ConnectionDecisionPredicate::~ConnectionDecisionPredicate

(

)

[inline, virtual]

Destruct me.

Definition at line 42 of file ConnectionDecisionPredicate.h.

---

Member Function Documentation

virtual void ConnectionDecisionPredicate::init	(	SimObjectPopulation const &	src,
		SimObjectPopulation const &	dst,
		RandomEngine *	rnd
	)			[pure virtual]

This function will be called to tell the decision predicate about the source and destination poulation.

An implementation of this function will check the actual type of the population and store references to the populations which will be used later on in the implementation of decide since this function just gets the indices within the populations.

Implemented in ConnectionDecisionPredicateSpecialization< S, D >, LateralLongRangeOrientationConnectionPredicate, PyConnectionDecisionPredicate, RetinotopicOrientationConnectionPredicate, ConnectionDecisionPredicateSpecialization< SimObjectPopulation, SimObjectPopulation >, ConnectionDecisionPredicateSpecialization< SpatialFamilyPopulation, SpatialFamilyPopulation >, ConnectionDecisionPredicateSpecialization< SpatialSimObjectPopulation, SpatialSimObjectPopulation >, and ConnectionDecisionPredicateSpecialization< AugmentedSpatialPopulation, AugmentedSpatialPopulation >.

virtual bool ConnectionDecisionPredicate::decide	(	size_t	src,
		size_t	dst,
		RandomEngine *	rnd
	)			[pure virtual]

This function will be called to decide whether to make a connection or not.

Parameters:

	src	The index into the source population
	dst	The index into the destination population
	rnd	A reference to the RandomNumberEngine to use for stochastic decisions.

Since only the indices into the source and destination populations are provided the method init has to store references to them.

Implemented in ConnectionDecisionPredicateSpecialization< S, D >, EuclidianDistanceConnectionPredicate, LateralEuclidianDistanceConnectionPredicate, LateralLongRangeOrientationConnectionPredicate, PyConnectionDecisionPredicate, RetinotopicOrientationConnectionPredicate, SimilarAttributeConnectionPredicate, SphereConnectionPredicate, ConnectionDecisionPredicateSpecialization< SimObjectPopulation, SimObjectPopulation >, ConnectionDecisionPredicateSpecialization< SpatialFamilyPopulation, SpatialFamilyPopulation >, ConnectionDecisionPredicateSpecialization< SpatialSimObjectPopulation, SpatialSimObjectPopulation >, and ConnectionDecisionPredicateSpecialization< AugmentedSpatialPopulation, AugmentedSpatialPopulation >.

---

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

• /home/tnatschl/PCSIM-Sandbox/pcsim/pcsim/construction/ConnectionDecisionPredicate.h