ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType > Class Template Reference

#include <itkGradientDescentOptimizerBasev4ModifyGradientByLearningRateThreader.h>

+ Inheritance diagram for itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType >:
+ Collaboration diagram for itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType >:

Public Types

using AssociateType = typename Superclass::AssociateType
 
using ConstPointer = SmartPointer< const Self >
 
using DomainType = typename Superclass::DomainType
 
using IndexRangeType = DomainType
 
using Pointer = SmartPointer< Self >
 
using Self = GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate
 
using Superclass = DomainThreader< ThreadedIndexedContainerPartitioner, GradientDescentOptimizerBasev4Template< TInternalComputationValueType > >
 
- Public Types inherited from itk::DomainThreader< ThreadedIndexedContainerPartitioner, GradientDescentOptimizerBasev4Template< TInternalComputationValueType > >
using AssociateType = GradientDescentOptimizerBasev4Template< TInternalComputationValueType >
 
using ConstPointer = SmartPointer< const Self >
 
using DomainPartitionerType = ThreadedIndexedContainerPartitioner
 
using DomainType = typename DomainPartitionerType::DomainType
 
using Pointer = SmartPointer< Self >
 
using Self = DomainThreader
 
using Superclass = Object
 
- 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

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::DomainThreader< ThreadedIndexedContainerPartitioner, GradientDescentOptimizerBasev4Template< TInternalComputationValueType > >
void Execute (AssociateType *enclosingClass, const DomainType &completeDomain)
 
virtual void SetDomainPartitioner (DomainPartitionerType *_arg)
 
virtual DomainPartitionerTypeGetModifiableDomainPartitioner ()
 
virtual const DomainPartitionerTypeGetDomainPartitioner () const
 
virtual ThreadIdType GetNumberOfWorkUnitsUsed () const
 
MultiThreaderBaseGetMultiThreader () const
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual ThreadIdType GetNumberOfWorkUnits () const
 
ThreadIdType GetMaximumNumberOfThreads () const
 
void SetMaximumNumberOfThreads (const ThreadIdType threads)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
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)
 
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 void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

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

 GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate ()=default
 
void ThreadedExecution (const IndexRangeType &subrange, const ThreadIdType threadId) override
 
 ~GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate () override=default
 
- Protected Member Functions inherited from itk::DomainThreader< ThreadedIndexedContainerPartitioner, GradientDescentOptimizerBasev4Template< TInternalComputationValueType > >
 DomainThreader ()
 
 ~DomainThreader () override=default
 
virtual void DetermineNumberOfWorkUnitsUsed ()
 
virtual void BeforeThreadedExecution ()
 
virtual void ThreadedExecution (const DomainType &subdomain, const ThreadIdType threadId)=0
 
virtual void AfterThreadedExecution ()
 
virtual void SetMultiThreader (MultiThreaderBase *_arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Additional Inherited Members

- Static Protected Member Functions inherited from itk::DomainThreader< ThreadedIndexedContainerPartitioner, GradientDescentOptimizerBasev4Template< TInternalComputationValueType > >
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Protected Attributes inherited from itk::DomainThreader< ThreadedIndexedContainerPartitioner, GradientDescentOptimizerBasev4Template< TInternalComputationValueType > >
AssociateTypem_Associate
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TInternalComputationValueType>
class itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType >

Modify the gradient by the learning rate for GradientDescentOptimizerBasev4.

Definition at line 37 of file itkGradientDescentOptimizerBasev4ModifyGradientByLearningRateThreader.h.

Member Typedef Documentation

◆ AssociateType

template<typename TInternalComputationValueType >
using itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType >::AssociateType = typename Superclass::AssociateType

◆ ConstPointer

template<typename TInternalComputationValueType >
using itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType >::ConstPointer = SmartPointer<const Self>

◆ DomainType

template<typename TInternalComputationValueType >
using itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType >::DomainType = typename Superclass::DomainType

◆ IndexRangeType

template<typename TInternalComputationValueType >
using itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType >::IndexRangeType = DomainType

◆ Pointer

template<typename TInternalComputationValueType >
using itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType >::Pointer = SmartPointer<Self>

◆ Self

Standard class type aliases.

Definition at line 45 of file itkGradientDescentOptimizerBasev4ModifyGradientByLearningRateThreader.h.

◆ Superclass

template<typename TInternalComputationValueType >
using itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType >::Superclass = DomainThreader<ThreadedIndexedContainerPartitioner, GradientDescentOptimizerBasev4Template<TInternalComputationValueType> >

Constructor & Destructor Documentation

◆ GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate()

template<typename TInternalComputationValueType >
itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType >::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate ( )
protecteddefault

◆ ~GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate()

template<typename TInternalComputationValueType >
itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType >::~GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate ( )
overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

template<typename TInternalComputationValueType >
virtual::itk::LightObject::Pointer itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

◆ GetNameOfClass()

template<typename TInternalComputationValueType >
virtual const char* itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType >::GetNameOfClass ( ) const
virtual

◆ New()

template<typename TInternalComputationValueType >
static Pointer itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType >::New ( )
static

◆ ThreadedExecution()

template<typename TInternalComputationValueType >
void itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType >::ThreadedExecution ( const IndexRangeType subrange,
const ThreadIdType  threadId 
)
overrideprotected

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