FTMDataTypes.h

Go to the documentation of this file.

 
#pragma once
 
#include <DataTypes.h>
#include <functional>
#include <limits>
#include <set>
#include <tuple>
 
// untied OpenMP tasks are causing segfaults in MergeTreeClustering when
// compiled with Clang
#ifdef __clang__
#define UNTIED()
#else
#define UNTIED() untied
#endif
 
namespace ttk {
  namespace ftm {
    // Types
    // --------

    using idSuperArc = long unsigned int;
    using idNode = unsigned int;

    // Warning, in long long int the max super arc is -1, might not be able to
    // deal with too large data
    using idCorresp = long long int;

    using idSegment = idSuperArc;

    using numThread = ThreadId;

    using ufDataType = long int;

    using idThread = ThreadId;

    using idTask = TaskId;

    using valence = SimplexId;
 
    // For tasks:
    // Set using scalar value comparison
    using VertCompFN = std::function<bool(SimplexId, SimplexId)>;
    using SetPropagation = std::set<SimplexId, VertCompFN>;
    using SetCompFN
      = std::function<bool(const SetPropagation &, const SetPropagation &)>;
 
    // Special values for types
    // --------------------------
 
    // QUESTION impact on performance using max (0 would be faster alloacted)
    static const idSuperArc nullSuperArc
      = std::numeric_limits<idSuperArc>::max();
    static const idNode nullNodes = std::numeric_limits<idNode>::max();
    static const SimplexId nullVertex = std::numeric_limits<SimplexId>::max();
    static const SimplexId nullEdge = std::numeric_limits<SimplexId>::max();
    static const SimplexId nullCell = std::numeric_limits<SimplexId>::max();
    static const idCorresp nullCorresp = std::numeric_limits<idCorresp>::max();
    static const idSegment nullSegment = std::numeric_limits<idSegment>::max();
    static const ufDataType nullUfData = std::numeric_limits<ufDataType>::max();
    static constexpr ufDataType specialUfData
      = std::numeric_limits<ufDataType>::max() - 1;
    static const idThread nullThread = std::numeric_limits<idThread>::max();
 
    // Enum data
    // ----------
 
    enum TreeType : char { Join = 0, Split = 1, Contour = 2, Join_Split = 3 };
 
    enum SimplifMethod : char { Persist = 0, Span = 1, NbVert = 2, NbArc = 3 };
 
    enum ComponentState : char { Visible, Hidden, Pruned, Merged };
 
    enum class TreeComponent {
      Arc = -1,
      Local_minimum,
      Saddle1,
      Saddle2,
      Local_maximum
    };
 
    enum class ArcType : char {
      Min_arc = 0,
      Max_arc,
      Saddle1_arc,
      Saddle2_arc,
      Saddle1_saddle2_arc
    };
  } // namespace ftm
} // namespace ttk
 
// Tests
// Stats time are not compatible with CT, only MT
// #define withStatsTime 1
 
// #define withProcessSpeed 1