#include <HelloWorld.h>

Inheritance diagram for ttk::HelloWorld:

Public Member Functions
	HelloWorld ()

int	preconditionTriangulation (ttk::AbstractTriangulation *triangulation) const

template<class dataType , class triangulationType = ttk::AbstractTriangulation>
int	computeAverages (dataType outputData, const dataType inputData, const triangulationType *triangulation) const

Public Member Functions inherited from ttk::Debug
	Debug ()

	~Debug () override

virtual int	setDebugLevel (const int &debugLevel)

int	setWrapper (const Wrapper *wrapper) override

int	printMsg (const std::string &msg, const debug::Priority &priority=debug::Priority::INFO, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const

int	printMsg (const std::vector< std::string > &msgs, const debug::Priority &priority=debug::Priority::INFO, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const

int	printErr (const std::string &msg, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cerr) const

int	printWrn (const std::string &msg, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cerr) const

int	printMsg (const std::string &msg, const double &progress, const double &time, const int &threads, const double &memory, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::PERFORMANCE, std::ostream &stream=std::cout) const

int	printMsg (const std::string &msg, const double &progress, const double &time, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::PERFORMANCE, std::ostream &stream=std::cout) const

int	printMsg (const std::string &msg, const double &progress, const double &time, const int &threads, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::PERFORMANCE, std::ostream &stream=std::cout) const

int	printMsg (const std::string &msg, const double &progress, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::PERFORMANCE, std::ostream &stream=std::cout) const

int	printMsg (const std::string &msg, const double &progress, const debug::Priority &priority, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const

int	printMsg (const std::vector< std::vector< std::string > > &rows, const debug::Priority &priority=debug::Priority::INFO, const bool hasHeader=true, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const

int	printMsg (const debug::Separator &separator, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::INFO, std::ostream &stream=std::cout) const

int	printMsg (const debug::Separator &separator, const debug::Priority &priority, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const

int	printMsg (const std::string &msg, const debug::Separator &separator, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::INFO, std::ostream &stream=std::cout) const

void	setDebugMsgPrefix (const std::string &prefix)

Public Member Functions inherited from ttk::BaseClass
	BaseClass ()

virtual	~BaseClass ()=default

int	getThreadNumber () const

virtual int	setThreadNumber (const int threadNumber)

virtual int	setWrapper (const Wrapper *wrapper)

Additional Inherited Members
Protected Member Functions inherited from ttk::Debug
int	printMsgInternal (const std::string &msg, const std::string &right, const std::string &filler, const debug::Priority &priority=debug::Priority::INFO, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const

int	printMsgInternal (const std::string &msg, const debug::Priority &priority, const debug::LineMode &lineMode, std::ostream &stream=std::cout) const

int	welcomeMsg (std::ostream &stream)

Protected Attributes inherited from ttk::Debug
int	debugLevel_

std::string	debugMsgPrefix_

std::string	debugMsgNamePrefix_

Protected Attributes inherited from ttk::BaseClass
bool	lastObject_

int	threadNumber_

Wrapper *	wrapper_

Static Protected Attributes inherited from ttk::Debug
static COMMON_EXPORTS debug::LineMode	lastLineMode = ttk::debug::LineMode::NEW

Detailed Description

The HelloWorld class provides methods to compute for each vertex of a triangulation the average scalar value of itself and its direct neighbors.

TODO 1: Provide your information

Author: Your Name Here your..nosp@m.emai.nosp@m.l@add.nosp@m.ress.nosp@m..here

Date: The Date Here.

This module defines the HelloWorld class that computes for each vertex of a triangulation the average scalar value of itself and its direct neighbors.

Related publication:
'HelloWorld' Jonas Lukasczyk and Julien Tierny. TTK Publications. 2021.

Definition at line 30 of file HelloWorld.h.

Constructor & Destructor Documentation

◆ HelloWorld()

ttk::HelloWorld::HelloWorld ( )

Definition at line 3 of file HelloWorld.cpp.

Member Function Documentation

◆ computeAverages()

template<class dataType , class triangulationType = ttk::AbstractTriangulation>

int ttk::HelloWorld::computeAverages	(	dataType *	outputData,
		const dataType *	inputData,
		const triangulationType *	triangulation
	)		const

inline

TODO 3: Implementation of the algorithm.

    Note: If the algorithm requires a triangulation then this
          method must be called after the triangulation has been
          preconditioned for the upcoming operations.

Definition at line 57 of file HelloWorld.h.

◆ preconditionTriangulation()

int ttk::HelloWorld::preconditionTriangulation ( ttk::AbstractTriangulation * triangulation ) const

inline

TODO 2: This method preconditions the triangulation for all operations the algorithm of this module requires. For instance, preconditionVertexNeighbors, preconditionBoundaryEdges, ...

Note: If the algorithm does not require a triangulation then this method can be deleted.

Definition at line 43 of file HelloWorld.h.

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

/home/julien/Pro/git/github/ttk-tierny/core/base/helloWorld/HelloWorld.h
/home/julien/Pro/git/github/ttk-tierny/core/base/helloWorld/HelloWorld.cpp