#include <aims/geodesicpath/geodesic_algorithm_base.h>

Inheritance diagram for geodesic::GeodesicAlgorithmBase:

[legend]

Collaboration diagram for geodesic::GeodesicAlgorithmBase:

[legend]

Public Types
enum	AlgorithmType { EXACT , DIJKSTRA , SUBDIVISION , UNDEFINED_ALGORITHM }

Public Member Functions
	GeodesicAlgorithmBase (geodesic::Mesh *mesh)

virtual	~GeodesicAlgorithmBase ()

virtual void	propagate (std::vector< SurfacePoint > &sources, double max_propagation_distance=GEODESIC_INF, std::vector< SurfacePoint > *stop_points=NULL)=0

virtual void	trace_back (SurfacePoint &destination, std::vector< SurfacePoint > &path)=0

virtual void	trace_back_with_index (SurfacePoint &destination, std::vector< SurfacePoint > &path, std::vector< unsigned > &indexVertex)=0

void	geodesic (SurfacePoint &source, SurfacePoint &destination, std::vector< SurfacePoint > &path)

void	geodesic (std::vector< SurfacePoint > &sources, std::vector< SurfacePoint > &destinations, std::vector< std::vector< SurfacePoint > > &paths)

void	geodesic (SurfacePoint &source, SurfacePoint &destination, std::vector< SurfacePoint > &path, std::vector< unsigned > &indexVertex)

void	geodesic (SurfacePoint &sources, std::vector< SurfacePoint > &destinations, std::vector< std::vector< SurfacePoint > > &paths, std::vector< std::vector< unsigned > > &indexVertex)

double	length (std::vector< SurfacePoint > &path)

void	print_info_about_path (std::vector< SurfacePoint > &path)

virtual unsigned	best_source (SurfacePoint &point, double &best_source_distance)=0

virtual void	print_statistics ()

AlgorithmType	type ()

virtual std::string	name ()

geodesic::Mesh *	mesh ()

Protected Types
typedef std::pair< vertex_pointer, double >	stop_vertex_with_distace_type

Protected Member Functions
void	set_stop_conditions (std::vector< SurfacePoint > *stop_points, double stop_distance)

double	stop_distance ()

Protected Attributes
AlgorithmType	m_type

std::vector< stop_vertex_with_distace_type >	m_stop_vertices

double	m_max_propagation_distance

geodesic::Mesh *	m_mesh

double	m_time_consumed

double	m_propagation_distance_stopped

Detailed Description

Definition at line 13 of file geodesic_algorithm_base.h.

Member Typedef Documentation

◆ stop_vertex_with_distace_type

typedef std::pair<vertex_pointer, double> geodesic::GeodesicAlgorithmBase::stop_vertex_with_distace_type

protected

Definition at line 86 of file geodesic_algorithm_base.h.

Member Enumeration Documentation

◆ AlgorithmType

enum geodesic::GeodesicAlgorithmBase::AlgorithmType

Enumerator
EXACT
DIJKSTRA
SUBDIVISION
UNDEFINED_ALGORITHM

Definition at line 16 of file geodesic_algorithm_base.h.

Constructor & Destructor Documentation

◆ GeodesicAlgorithmBase()

geodesic::GeodesicAlgorithmBase::GeodesicAlgorithmBase ( geodesic::Mesh * mesh )

inline

Definition at line 24 of file geodesic_algorithm_base.h.

◆ ~GeodesicAlgorithmBase()

virtual geodesic::GeodesicAlgorithmBase::~GeodesicAlgorithmBase ( )

inlinevirtual

Definition at line 30 of file geodesic_algorithm_base.h.

Member Function Documentation

◆ best_source()

virtual unsigned geodesic::GeodesicAlgorithmBase::best_source	(	SurfacePoint &	point,
		double &	best_source_distance
	)

pure virtual

Implemented in geodesic::GeodesicAlgorithmGraphBase< Node >, geodesic::GeodesicAlgorithmGraphBase< DijkstraNode >, geodesic::GeodesicAlgorithmGraphBase< SubdivisionNode >, geodesic::GeodesicAlgorithmExact, and geodesic::GeodesicAlgorithmDijkstraAlternative.

◆ geodesic() [1/4]

void geodesic::GeodesicAlgorithmBase::geodesic	(	std::vector< SurfacePoint > &	sources,
		std::vector< SurfacePoint > &	destinations,
		std::vector< std::vector< SurfacePoint > > &	paths
	)

inline

Definition at line 162 of file geodesic_algorithm_base.h.

References geodesic::GEODESIC_INF, propagate(), and trace_back().

◆ geodesic() [2/4]

void geodesic::GeodesicAlgorithmBase::geodesic	(	SurfacePoint &	source,
		SurfacePoint &	destination,
		std::vector< SurfacePoint > &	path
	)

inline

Definition at line 132 of file geodesic_algorithm_base.h.

References geodesic::GEODESIC_INF, propagate(), and trace_back().

◆ geodesic() [3/4]

void geodesic::GeodesicAlgorithmBase::geodesic	(	SurfacePoint &	source,
		SurfacePoint &	destination,
		std::vector< SurfacePoint > &	path,
		std::vector< unsigned > &	indexVertex
	)

inline

Definition at line 147 of file geodesic_algorithm_base.h.

References geodesic::GEODESIC_INF, propagate(), and trace_back_with_index().

◆ geodesic() [4/4]

void geodesic::GeodesicAlgorithmBase::geodesic	(	SurfacePoint &	sources,
		std::vector< SurfacePoint > &	destinations,
		std::vector< std::vector< SurfacePoint > > &	paths,
		std::vector< std::vector< unsigned > > &	indexVertex
	)

inline

Definition at line 180 of file geodesic_algorithm_base.h.

References geodesic::GEODESIC_INF, propagate(), and trace_back_with_index().

◆ length()

double geodesic::GeodesicAlgorithmBase::length ( std::vector< SurfacePoint > & path )

inline

Definition at line 96 of file geodesic_algorithm_base.h.

Referenced by print_info_about_path(), and geodesic::GeodesicAlgorithmExact::propagate().

◆ mesh()

geodesic::Mesh* geodesic::GeodesicAlgorithmBase::mesh ( )

inline

Definition at line 74 of file geodesic_algorithm_base.h.

References m_mesh.

Referenced by geodesic::GeodesicAlgorithmDijkstra::GeodesicAlgorithmDijkstra(), geodesic::GeodesicAlgorithmExact::GeodesicAlgorithmExact(), and geodesic::GeodesicAlgorithmSubdivision::GeodesicAlgorithmSubdivision().

◆ name()

std::string geodesic::GeodesicAlgorithmBase::name ( )

inlinevirtual

Definition at line 116 of file geodesic_algorithm_base.h.

References DIJKSTRA, EXACT, m_type, SUBDIVISION, and UNDEFINED_ALGORITHM.

◆ print_info_about_path()

void geodesic::GeodesicAlgorithmBase::print_info_about_path ( std::vector< SurfacePoint > & path )

inline

Definition at line 109 of file geodesic_algorithm_base.h.

References length().

◆ print_statistics()

virtual void geodesic::GeodesicAlgorithmBase::print_statistics ( )

inlinevirtual

Reimplemented in geodesic::GeodesicAlgorithmGraphBase< Node >, geodesic::GeodesicAlgorithmGraphBase< DijkstraNode >, geodesic::GeodesicAlgorithmGraphBase< SubdivisionNode >, and geodesic::GeodesicAlgorithmExact.

Definition at line 65 of file geodesic_algorithm_base.h.

References m_time_consumed.

Referenced by geodesic::GeodesicAlgorithmExact::print_statistics(), and geodesic::GeodesicAlgorithmGraphBase< Node >::print_statistics().

◆ propagate()

virtual void geodesic::GeodesicAlgorithmBase::propagate	(	std::vector< SurfacePoint > &	sources,
		double	max_propagation_distance = `GEODESIC_INF`,
		std::vector< SurfacePoint > *	stop_points = `NULL`
	)

pure virtual

Implemented in geodesic::GeodesicAlgorithmGraphBase< Node >, geodesic::GeodesicAlgorithmGraphBase< DijkstraNode >, geodesic::GeodesicAlgorithmGraphBase< SubdivisionNode >, geodesic::GeodesicAlgorithmExact, and geodesic::GeodesicAlgorithmDijkstraAlternative.

Referenced by geodesic().

◆ set_stop_conditions()

void geodesic::GeodesicAlgorithmBase::set_stop_conditions	(	std::vector< SurfacePoint > *	stop_points,
		double	stop_distance
	)

inlineprotected

Definition at line 201 of file geodesic_algorithm_base.h.

References geodesic::Mesh::closest_vertices(), geodesic::Point3D::distance(), m_max_propagation_distance, m_mesh, m_stop_vertices, and stop_distance().

Referenced by geodesic::GeodesicAlgorithmDijkstraAlternative::propagate(), and geodesic::GeodesicAlgorithmExact::propagate().

◆ stop_distance()

double geodesic::GeodesicAlgorithmBase::stop_distance ( )

inlineprotected

Definition at line 79 of file geodesic_algorithm_base.h.

References m_max_propagation_distance.

Referenced by set_stop_conditions().

◆ trace_back()

virtual void geodesic::GeodesicAlgorithmBase::trace_back	(	SurfacePoint &	destination,
		std::vector< SurfacePoint > &	path
	)

pure virtual

Implemented in geodesic::GeodesicAlgorithmGraphBase< Node >, geodesic::GeodesicAlgorithmGraphBase< DijkstraNode >, geodesic::GeodesicAlgorithmGraphBase< SubdivisionNode >, geodesic::GeodesicAlgorithmExact, and geodesic::GeodesicAlgorithmDijkstraAlternative.

Referenced by geodesic().

◆ trace_back_with_index()

virtual void geodesic::GeodesicAlgorithmBase::trace_back_with_index	(	SurfacePoint &	destination,
		std::vector< SurfacePoint > &	path,
		std::vector< unsigned > &	indexVertex
	)

pure virtual

Implemented in geodesic::GeodesicAlgorithmGraphBase< Node >, geodesic::GeodesicAlgorithmGraphBase< DijkstraNode >, geodesic::GeodesicAlgorithmGraphBase< SubdivisionNode >, and geodesic::GeodesicAlgorithmExact.

Referenced by geodesic().

◆ type()

AlgorithmType geodesic::GeodesicAlgorithmBase::type ( )

inline

Definition at line 70 of file geodesic_algorithm_base.h.

References m_type.

Member Data Documentation

◆ m_max_propagation_distance

double geodesic::GeodesicAlgorithmBase::m_max_propagation_distance

protected

Definition at line 88 of file geodesic_algorithm_base.h.

Referenced by set_stop_conditions(), and stop_distance().

◆ m_mesh

geodesic::Mesh* geodesic::GeodesicAlgorithmBase::m_mesh

protected

Definition at line 90 of file geodesic_algorithm_base.h.

Referenced by geodesic::GeodesicAlgorithmDijkstraAlternative::best_source(), geodesic::GeodesicAlgorithmDijkstra::GeodesicAlgorithmDijkstra(), geodesic::GeodesicAlgorithmDijkstraAlternative::GeodesicAlgorithmDijkstraAlternative(), mesh(), geodesic::GeodesicAlgorithmSubdivision::node_indexx(), geodesic::GeodesicAlgorithmDijkstraAlternative::propagate(), set_stop_conditions(), geodesic::GeodesicAlgorithmSubdivision::set_subdivision_level(), and geodesic::GeodesicAlgorithmDijkstraAlternative::trace_back().

◆ m_propagation_distance_stopped

double geodesic::GeodesicAlgorithmBase::m_propagation_distance_stopped

protected

Definition at line 93 of file geodesic_algorithm_base.h.

Referenced by geodesic::GeodesicAlgorithmGraphBase< Node >::best_first_node(), and geodesic::GeodesicAlgorithmExact::propagate().

◆ m_stop_vertices

std::vector<stop_vertex_with_distace_type> geodesic::GeodesicAlgorithmBase::m_stop_vertices

protected

Definition at line 87 of file geodesic_algorithm_base.h.

Referenced by set_stop_conditions().

◆ m_time_consumed

double geodesic::GeodesicAlgorithmBase::m_time_consumed

protected

Definition at line 92 of file geodesic_algorithm_base.h.

Referenced by print_statistics(), geodesic::GeodesicAlgorithmDijkstraAlternative::propagate(), and geodesic::GeodesicAlgorithmExact::propagate().

◆ m_type

AlgorithmType geodesic::GeodesicAlgorithmBase::m_type

protected

Definition at line 84 of file geodesic_algorithm_base.h.

Referenced by geodesic::GeodesicAlgorithmDijkstra::GeodesicAlgorithmDijkstra(), geodesic::GeodesicAlgorithmDijkstraAlternative::GeodesicAlgorithmDijkstraAlternative(), geodesic::GeodesicAlgorithmExact::GeodesicAlgorithmExact(), geodesic::GeodesicAlgorithmSubdivision::GeodesicAlgorithmSubdivision(), name(), and type().

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

aims/geodesicpath/geodesic_algorithm_base.h

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ stop_vertex_with_distace_type

Member Enumeration Documentation

◆ AlgorithmType

Constructor & Destructor Documentation

◆ GeodesicAlgorithmBase()

◆ ~GeodesicAlgorithmBase()

Member Function Documentation

◆ best_source()

◆ geodesic() [1/4]

◆ geodesic() [2/4]

◆ geodesic() [3/4]

◆ geodesic() [4/4]

◆ length()

◆ mesh()

◆ name()

◆ print_info_about_path()

◆ print_statistics()

◆ propagate()

◆ set_stop_conditions()

◆ stop_distance()

◆ trace_back()

◆ trace_back_with_index()

◆ type()

Member Data Documentation

◆ m_max_propagation_distance

◆ m_mesh

◆ m_propagation_distance_stopped

◆ m_stop_vertices

◆ m_time_consumed

◆ m_type