bpp::TopologyListener Class Reference

Implement this interface to be notified when the topology of a tree has changed during topology search. More...

#include <Bpp/Phyl/TopologySearch.h>

Inheritance diagram for bpp::TopologyListener:

Collaboration diagram for bpp::TopologyListener:

Public Member Functions
	TopologyListener ()
virtual	~TopologyListener ()
TopologyListener *	clone () const =0
virtual void	topologyChangePerformed (const TopologyChangeEvent &event)
	Notify a topology change event. More...
virtual void	topologyChangeTested (const TopologyChangeEvent &event)=0
	Notify a topology change event. More...
virtual void	topologyChangeSuccessful (const TopologyChangeEvent &event)=0
	Tell that a topology change is definitive. More...

Detailed Description

Implement this interface to be notified when the topology of a tree has changed during topology search.

Definition at line 82 of file TopologySearch.h.

Constructor & Destructor Documentation

TopologyListener()

bpp::TopologyListener::TopologyListener ( )

inline

Definition at line 86 of file TopologySearch.h.

~TopologyListener()

virtual bpp::TopologyListener::~TopologyListener ( )

inlinevirtual

Definition at line 87 of file TopologySearch.h.

Member Function Documentation

clone()

TopologyListener* bpp::TopologyListener::clone ( ) const

pure virtual

Implemented in bpp::NNITopologyListener2, bpp::NNIHomogeneousTreeLikelihood, bpp::NNITopologyListener, bpp::NNISearchable, and bpp::DRTreeParsimonyScore.

topologyChangePerformed()

virtual void bpp::TopologyListener::topologyChangePerformed ( const TopologyChangeEvent &  event )

inlinevirtual

Notify a topology change event.

This method is to be invoked after one or several NNI are performed. It allows appropriate recomputations.

In most case, this is the same as topologyChangeTested() + topologyChangeSuccessful().

Parameters

event

The topology change event.

Definition at line 105 of file TopologySearch.h.

References topologyChangeSuccessful(), and topologyChangeTested().

topologyChangeSuccessful()

virtual void bpp::TopologyListener::topologyChangeSuccessful ( const TopologyChangeEvent &  event )

pure virtual

Tell that a topology change is definitive.

This method is called after the topologyChangeTested() method.

Parameters

event

The topology change event.

Implemented in bpp::NNITopologyListener2, bpp::NNIHomogeneousTreeLikelihood, bpp::NNITopologyListener, and bpp::DRTreeParsimonyScore.

Referenced by topologyChangePerformed().

topologyChangeTested()

virtual void bpp::TopologyListener::topologyChangeTested ( const TopologyChangeEvent &  event )

pure virtual

Notify a topology change event.

Parameters

event

The topology change event.

Implemented in bpp::NNITopologyListener2, bpp::NNIHomogeneousTreeLikelihood, bpp::NNITopologyListener, and bpp::DRTreeParsimonyScore.

Referenced by topologyChangePerformed().

---

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

• Bpp/Phyl/TopologySearch.h