Public Member Functions | List of all members
gtsam::DiscreteKeys Struct Reference

DiscreteKeys is a set of keys that can be assembled using the & operator. More...

#include <DiscreteKey.h>

Inheritance diagram for gtsam::DiscreteKeys:
Inheritance graph
[legend]

Public Member Functions

GTSAM_EXPORT std::map< Key, size_tcardinalities () const
 Return a map from index to cardinality. More...
 
 DiscreteKeys ()
 Default constructor. More...
 
 DiscreteKeys (const DiscreteKey &key)
 Construct from a key. More...
 
 DiscreteKeys (const std::vector< DiscreteKey > &keys)
 Construct from a vector of keys. More...
 
GTSAM_EXPORT DiscreteKeys (const std::vector< int > &cs)
 Construct from cardinalities with default names. More...
 
GTSAM_EXPORT KeyVector indices () const
 Return a vector of indices. More...
 
DiscreteKeysoperator& (const DiscreteKey &key)
 Add a key (non-const!) More...
 

Detailed Description

DiscreteKeys is a set of keys that can be assembled using the & operator.

Definition at line 37 of file DiscreteKey.h.

Constructor & Destructor Documentation

gtsam::DiscreteKeys::DiscreteKeys ( )
inline

Default constructor.

Definition at line 40 of file DiscreteKey.h.

gtsam::DiscreteKeys::DiscreteKeys ( const DiscreteKey key)
inline

Construct from a key.

Definition at line 44 of file DiscreteKey.h.

gtsam::DiscreteKeys::DiscreteKeys ( const std::vector< DiscreteKey > &  keys)
inline

Construct from a vector of keys.

Definition at line 49 of file DiscreteKey.h.

gtsam::DiscreteKeys::DiscreteKeys ( const std::vector< int > &  cs)

Construct from cardinalities with default names.

Definition at line 27 of file DiscreteKey.cpp.

Member Function Documentation

map< Key, size_t > gtsam::DiscreteKeys::cardinalities ( ) const

Return a map from index to cardinality.

Definition at line 41 of file DiscreteKey.cpp.

KeyVector gtsam::DiscreteKeys::indices ( ) const

Return a vector of indices.

Definition at line 34 of file DiscreteKey.cpp.

DiscreteKeys& gtsam::DiscreteKeys::operator& ( const DiscreteKey key)
inline

Add a key (non-const!)

Definition at line 63 of file DiscreteKey.h.


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


gtsam
Author(s):
autogenerated on Sat May 8 2021 02:58:08