ITerminalNodePolicy.h

Go to the documentation of this file.

#ifndef GUM_MULTI_DIM_FUNCTION_GRAPH_INTERFACE_TERMINAL_NODE_POLICY_H
#define GUM_MULTI_DIM_FUNCTION_GRAPH_INTERFACE_TERMINAL_NODE_POLICY_H

#include <agrum/graphs/parts/nodeGraphPart.h>

namespace gum {

  // clang-format off
  template <typename GUM_SCALAR>
  class ITerminalNodePolicy {

    public:
    // ============================================================================
    // ============================================================================

    virtual void addTerminalNode( const NodeId& n, const GUM_SCALAR& v ) = 0;

    virtual void eraseTerminalNode( const NodeId& n ) = 0;

    virtual void clearAllTerminalNodes() = 0;

    // ============================================================================
    // ============================================================================

    virtual bool existsTerminalNodeWithId( const NodeId& n ) const = 0;

    virtual bool existsTerminalNodeWithValue( const GUM_SCALAR& v ) const = 0;

    // ============================================================================
    // ============================================================================

    virtual const GUM_SCALAR& terminalNodeValue( const NodeId& n ) const = 0;

    virtual const NodeId& terminalNodeId( const GUM_SCALAR& v ) const = 0;

    // ============================================================================
    // ============================================================================

    virtual void beginValues() const = 0;

    virtual bool hasValue() const = 0;

    virtual void nextValue() const = 0;

    virtual const GUM_SCALAR& value() const = 0;

    virtual const NodeId& id() const = 0;

  };

}  // End of namespace gum

#endif /* GUM_MULTI_DIM_FUNCTION_GRAPH_INTERFACE_TERMINAL_NODE_POLICY_H */