TTK
Loading...
Searching...
No Matches
Public Member Functions | List of all members
ttk::ftr::Scalars< ScalarType > Class Template Reference

#include <FTRScalars.h>

Inheritance diagram for ttk::ftr::Scalars< ScalarType >:
ttk::Debug ttk::BaseClass

Public Member Functions

 Scalars ()=default
 
 Scalars (const Scalars &o)=delete
 
ScalarType * getScalars ()
 
const SimplexIdgetOffsets () const
 
idVertex getSize () const
 
ScalarType getVal (const idVertex i) const
 
idVertex getSortedVert (const idVertex i) const
 
idVertex getMirror (const idVertex i) const
 
void setSize (const idVertex size)
 
void setScalars (ScalarType *values)
 
void setOffsets (const SimplexId *const sos)
 
void alloc ()
 
void init ()
 
void removeNaN ()
 
bool isLower (const idVertex a, const idVertex b) const
 
bool isHigher (const idVertex a, const idVertex b) 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_
 
Wrapperwrapper_
 
- Static Protected Attributes inherited from ttk::Debug
static COMMON_EXPORTS debug::LineMode lastLineMode = ttk::debug::LineMode::NEW
 

Detailed Description

template<typename ScalarType>
class ttk::ftr::Scalars< ScalarType >

Definition at line 21 of file FTRScalars.h.

Constructor & Destructor Documentation

◆ Scalars() [1/2]

template<typename ScalarType >
ttk::ftr::Scalars< ScalarType >::Scalars ( )
default

◆ Scalars() [2/2]

template<typename ScalarType >
ttk::ftr::Scalars< ScalarType >::Scalars ( const Scalars< ScalarType > &  o)
delete

Member Function Documentation

◆ alloc()

template<typename ScalarType >
void ttk::ftr::Scalars< ScalarType >::alloc ( )
inline

Definition at line 80 of file FTRScalars.h.

◆ getMirror()

template<typename ScalarType >
idVertex ttk::ftr::Scalars< ScalarType >::getMirror ( const idVertex  i) const
inline

Definition at line 56 of file FTRScalars.h.

◆ getOffsets()

template<typename ScalarType >
const SimplexId * ttk::ftr::Scalars< ScalarType >::getOffsets ( ) const
inline

Definition at line 40 of file FTRScalars.h.

◆ getScalars()

template<typename ScalarType >
ScalarType * ttk::ftr::Scalars< ScalarType >::getScalars ( )
inline

Definition at line 36 of file FTRScalars.h.

◆ getSize()

template<typename ScalarType >
idVertex ttk::ftr::Scalars< ScalarType >::getSize ( ) const
inline

Definition at line 44 of file FTRScalars.h.

◆ getSortedVert()

template<typename ScalarType >
idVertex ttk::ftr::Scalars< ScalarType >::getSortedVert ( const idVertex  i) const
inline

Definition at line 52 of file FTRScalars.h.

◆ getVal()

template<typename ScalarType >
ScalarType ttk::ftr::Scalars< ScalarType >::getVal ( const idVertex  i) const
inline

Definition at line 48 of file FTRScalars.h.

◆ init()

template<typename ScalarType >
void ttk::ftr::Scalars< ScalarType >::init ( )
inline

Definition at line 84 of file FTRScalars.h.

◆ isHigher()

template<typename ScalarType >
bool ttk::ftr::Scalars< ScalarType >::isHigher ( const idVertex  a,
const idVertex  b 
) const
inline

Definition at line 122 of file FTRScalars.h.

◆ isLower()

template<typename ScalarType >
bool ttk::ftr::Scalars< ScalarType >::isLower ( const idVertex  a,
const idVertex  b 
) const
inline

Definition at line 119 of file FTRScalars.h.

◆ removeNaN()

template<typename ScalarType >
void ttk::ftr::Scalars< ScalarType >::removeNaN ( )
inline

Definition at line 98 of file FTRScalars.h.

◆ setOffsets()

template<typename ScalarType >
void ttk::ftr::Scalars< ScalarType >::setOffsets ( const SimplexId *const  sos)
inline
Precondition
For this function to behave correctly in the absence of the VTK wrapper, ttk::preconditionOrderArray() needs to be called to fill the sos buffer prior to any computation (the VTK wrapper already includes a mechanism to automatically generate such a preconditioned buffer).
See also
examples/c++/main.cpp for an example use.

Definition at line 76 of file FTRScalars.h.

◆ setScalars()

template<typename ScalarType >
void ttk::ftr::Scalars< ScalarType >::setScalars ( ScalarType *  values)
inline

Definition at line 64 of file FTRScalars.h.

◆ setSize()

template<typename ScalarType >
void ttk::ftr::Scalars< ScalarType >::setSize ( const idVertex  size)
inline

Definition at line 60 of file FTRScalars.h.


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