ITK  6.0.0
Insight Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::SparseFieldLayer< TNodeType > Class Template Reference

#include <itkSparseFieldLayer.h>

Detailed Description

template<typename TNodeType>
class itk::SparseFieldLayer< TNodeType >

A very simple linked list that is used to manage nodes in a layer of a sparse field level-set solver.

This class implements a very simple linked list that is used to manage nodes in a layer of a sparse field level-set solver. For more information on the sparse field level-set solver, see documentation for itk::SparseFieldLevelSetImageFilter.
IMPORTANT!
One important and distinctive feature of this list implementation (in fact, the entire reason for this object's existence) is that no memory allocation/deallocation occurs during linking or unlinking of nodes. The nodes themselves are expected to carry the appropriate "Next" & "Previous" fields used to link. Guaranteeing that no calls to new or delete are ever made for normal list operations allows us to safely use this class in a multithread environment without incurring penalties from heap contention among threads. Because no allocation/deallocation occurs, it is entirely up to the calling program to manage the allocating and freeing of the list nodes.

Definition at line 162 of file itkSparseFieldLayer.h.

+ Inheritance diagram for itk::SparseFieldLayer< TNodeType >:
+ Collaboration diagram for itk::SparseFieldLayer< TNodeType >:

Classes

struct  RegionType
 

Public Types

using ConstIterator = ConstSparseFieldLayerIterator< NodeType >
 
using ConstPointer = SmartPointer< const Self >
 
using Iterator = SparseFieldLayerIterator< NodeType >
 
using NodeType = TNodeType
 
using Pointer = SmartPointer< Self >
 
using RegionListType = std::vector< RegionType >
 
using Self = SparseFieldLayer
 
using Superclass = Object
 
using ValueType = NodeType
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

Iterator Begin ()
 
ConstIterator Begin () const
 
Iterator End ()
 
ConstIterator End () const
 
NodeTypeFront ()
 
const NodeTypeFront () const
 
const char * GetNameOfClass () const override
 
unsigned int Size () const
 
RegionListType SplitRegions (int num) const
 
void Unlink (NodeType *n)
 
void PopFront ()
 
void PushFront (NodeType *n)
 
bool Empty () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
const char * GetNameOfClass () const override
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const override
 
 SparseFieldLayer ()
 
 ~SparseFieldLayer () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

const std::unique_ptr< NodeTypem_HeadNode { std::make_unique<NodeType>() }
 
unsigned int m_Size {}
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstIterator

template<typename TNodeType >
using itk::SparseFieldLayer< TNodeType >::ConstIterator = ConstSparseFieldLayerIterator<NodeType>

Const iterator type for the list.

Definition at line 190 of file itkSparseFieldLayer.h.

◆ ConstPointer

template<typename TNodeType >
using itk::SparseFieldLayer< TNodeType >::ConstPointer = SmartPointer<const Self>

Definition at line 171 of file itkSparseFieldLayer.h.

◆ Iterator

template<typename TNodeType >
using itk::SparseFieldLayer< TNodeType >::Iterator = SparseFieldLayerIterator<NodeType>

Iterator type for the list.

Definition at line 187 of file itkSparseFieldLayer.h.

◆ NodeType

template<typename TNodeType >
using itk::SparseFieldLayer< TNodeType >::NodeType = TNodeType

Type of node stored in the linked list.

Definition at line 180 of file itkSparseFieldLayer.h.

◆ Pointer

template<typename TNodeType >
using itk::SparseFieldLayer< TNodeType >::Pointer = SmartPointer<Self>

Definition at line 170 of file itkSparseFieldLayer.h.

◆ RegionListType

template<typename TNodeType >
using itk::SparseFieldLayer< TNodeType >::RegionListType = std::vector<RegionType>

Definition at line 199 of file itkSparseFieldLayer.h.

◆ Self

template<typename TNodeType >
using itk::SparseFieldLayer< TNodeType >::Self = SparseFieldLayer

Standard type alias.

Definition at line 168 of file itkSparseFieldLayer.h.

◆ Superclass

template<typename TNodeType >
using itk::SparseFieldLayer< TNodeType >::Superclass = Object

Definition at line 169 of file itkSparseFieldLayer.h.

◆ ValueType

template<typename TNodeType >
using itk::SparseFieldLayer< TNodeType >::ValueType = NodeType

Alias for the type of value stored in the list. Conforms to Standard Template Library vocabulary.

Definition at line 184 of file itkSparseFieldLayer.h.

Constructor & Destructor Documentation

◆ SparseFieldLayer()

template<typename TNodeType >
itk::SparseFieldLayer< TNodeType >::SparseFieldLayer ( )
protected

◆ ~SparseFieldLayer()

template<typename TNodeType >
itk::SparseFieldLayer< TNodeType >::~SparseFieldLayer ( )
overrideprotecteddefault

Member Function Documentation

◆ Begin() [1/2]

template<typename TNodeType >
Iterator itk::SparseFieldLayer< TNodeType >::Begin ( )
inline

Returns an iterator pointing to the first node in the list.

Definition at line 249 of file itkSparseFieldLayer.h.

◆ Begin() [2/2]

template<typename TNodeType >
ConstIterator itk::SparseFieldLayer< TNodeType >::Begin ( ) const
inline

Returns a const iterator pointing to the first node in the list.

Definition at line 257 of file itkSparseFieldLayer.h.

◆ Empty()

template<typename TNodeType >
bool itk::SparseFieldLayer< TNodeType >::Empty ( ) const
inline

Returns TRUE if the list is empty, FALSE otherwise. Executes in constant time.

Definition at line 279 of file itkSparseFieldLayer.h.

◆ End() [1/2]

template<typename TNodeType >
Iterator itk::SparseFieldLayer< TNodeType >::End ( )
inline

Returns an iterator pointing one node past the end of the list.

Definition at line 264 of file itkSparseFieldLayer.h.

◆ End() [2/2]

template<typename TNodeType >
ConstIterator itk::SparseFieldLayer< TNodeType >::End ( ) const
inline

Returns a const iterator pointing one node past the end of the list.

Definition at line 271 of file itkSparseFieldLayer.h.

◆ Front() [1/2]

template<typename TNodeType >
NodeType * itk::SparseFieldLayer< TNodeType >::Front ( )
inline

Returns a pointer to the first node in the list. Constant time.

Definition at line 204 of file itkSparseFieldLayer.h.

◆ Front() [2/2]

template<typename TNodeType >
const NodeType * itk::SparseFieldLayer< TNodeType >::Front ( ) const
inline

Returns a const pointer to the first node in the list. Constant time.

Definition at line 211 of file itkSparseFieldLayer.h.

◆ GetNameOfClass()

template<typename TNodeType >
const char * itk::SparseFieldLayer< TNodeType >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ New()

template<typename TNodeType >
static Pointer itk::SparseFieldLayer< TNodeType >::New ( )
static

Method for creation through the object factory.

◆ PopFront()

template<typename TNodeType >
void itk::SparseFieldLayer< TNodeType >::PopFront ( )
inline

Unlinks the first node from the list. Constant time.

Definition at line 218 of file itkSparseFieldLayer.h.

◆ PrintSelf()

template<typename TNodeType >
void itk::SparseFieldLayer< TNodeType >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::Object.

◆ PushFront()

template<typename TNodeType >
void itk::SparseFieldLayer< TNodeType >::PushFront ( NodeType n)
inline

Links a node into the front of the list. Constant time.

Definition at line 228 of file itkSparseFieldLayer.h.

◆ Size()

template<typename TNodeType >
unsigned int itk::SparseFieldLayer< TNodeType >::Size ( ) const

Returns the number of elements in the list. Size() executes in constant time.

◆ SplitRegions()

template<typename TNodeType >
RegionListType itk::SparseFieldLayer< TNodeType >::SplitRegions ( int  num) const

Returns pointers to first and last+1 elements of num partitions of the itkSparseFieldLayer

◆ Unlink()

template<typename TNodeType >
void itk::SparseFieldLayer< TNodeType >::Unlink ( NodeType n)
inline

Unlinks a node from the list

Definition at line 240 of file itkSparseFieldLayer.h.

Member Data Documentation

◆ m_HeadNode

template<typename TNodeType >
const std::unique_ptr<NodeType> itk::SparseFieldLayer< TNodeType >::m_HeadNode { std::make_unique<NodeType>() }
private

The anchor node of the list. m_HeadNode->Next is the first node in the list. If m_HeadNode->Next == m_HeadNode, then the list is empty.

Definition at line 311 of file itkSparseFieldLayer.h.

◆ m_Size

template<typename TNodeType >
unsigned int itk::SparseFieldLayer< TNodeType >::m_Size {}
private

Definition at line 312 of file itkSparseFieldLayer.h.


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