Volume Cartographer 2.27.0
|
A simple class for keeping track of a connected chain of Particle objects. More...
#include <vc/segmentation/stps/ParticleChain.hpp>
Public Types | |
using | Chain = std::vector< Particle > |
Public Member Functions | |
ParticleChain ()=default | |
Default constructor. | |
ParticleChain (Chain c) | |
Constructor with chain initialization. More... | |
auto | operator+= (const ForceChain &rhs) -> ParticleChain & |
Add a list of offset vectors to each element in the chain. More... | |
auto | operator*= (const double &rhs) -> ParticleChain & |
Multiply each element of chain by a constant scale factor. | |
auto | operator[] (std::size_t i) |
Element access operator. More... | |
auto | operator[] (std::size_t i) const |
Element access operator. More... | |
auto | begin () |
Returns an iterator to the beginning of the chain. More... | |
auto | begin () const |
Returns an iterator to the beginning of the chain. More... | |
auto | end () |
Returns an iterator to the end of the chain. More... | |
auto | end () const |
Returns an iterator to the end of the chain. More... | |
template<class... Args> | |
void | emplace_back (Args &&... args) |
Constructs an element at the end of the chain. More... | |
void | push_back (const Particle &val) |
Adds an element to the end of the chain. More... | |
auto | size () -> std::size_t |
Returns the number of elements in the chain. More... | |
auto | size () const -> std::size_t |
Returns the number of elements in the chain. More... | |
void | clear () |
Empties and resets the chain. More... | |
Private Attributes | |
Chain | data_ |
A simple class for keeping track of a connected chain of Particle objects.
Definition at line 22 of file ParticleChain.hpp.
using volcart::segmentation::ParticleChain::Chain = std::vector<Particle> |
Data storage type
Definition at line 26 of file ParticleChain.hpp.
|
inlineexplicit |
Constructor with chain initialization.
Definition at line 32 of file ParticleChain.hpp.
|
inline |
Returns an iterator to the beginning of the chain.
Definition at line 53 of file ParticleChain.hpp.
|
inline |
Returns an iterator to the beginning of the chain.
Definition at line 56 of file ParticleChain.hpp.
|
inline |
Empties and resets the chain.
Definition at line 81 of file ParticleChain.hpp.
|
inline |
Constructs an element at the end of the chain.
Definition at line 66 of file ParticleChain.hpp.
|
inline |
Returns an iterator to the end of the chain.
Definition at line 59 of file ParticleChain.hpp.
|
inline |
Returns an iterator to the end of the chain.
Definition at line 62 of file ParticleChain.hpp.
auto volcart::segmentation::ParticleChain::operator+= | ( | const ForceChain & | rhs | ) | -> ParticleChain & |
Add a list of offset vectors to each element in the chain.
Offset vectors are added per element: PC[0] + FC[0]; PC[1] + FC[1]; ...
Throws std::domain_error
if ForceChain size doesn't match the size of the ParticleChain.
|
inline |
Element access operator.
Definition at line 47 of file ParticleChain.hpp.
|
inline |
Element access operator.
Definition at line 50 of file ParticleChain.hpp.
|
inline |
Adds an element to the end of the chain.
Definition at line 72 of file ParticleChain.hpp.
|
inline |
Returns the number of elements in the chain.
Definition at line 75 of file ParticleChain.hpp.
|
inline |
Returns the number of elements in the chain.
Definition at line 78 of file ParticleChain.hpp.
|
private |
Data storage vector
Definition at line 85 of file ParticleChain.hpp.