Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TMVA::TSynapse Class Reference

Synapse class used by TMVA artificial neural network methods.

Definition at line 42 of file TSynapse.h.

Public Member Functions

 TSynapse ()
 constructor
 
virtual ~TSynapse ()
 destructor
 
void AdjustWeight ()
 adjust the weight based on the error field all ready calculated by CalculateDelta
 
void CalculateDelta ()
 calculate/adjust the error field for this synapse
 
void DecayLearningRate (Double_t rate)
 
Double_t GetDEDw ()
 
Double_t GetDelta ()
 
Double_t GetLearningRate ()
 
Double_t GetWeight ()
 
Double_t GetWeightedDelta ()
 get error field of post-neuron weighted by synapse weight
 
Double_t GetWeightedValue ()
 get output of pre-neuron weighted by synapse weight
 
void InitDelta ()
 
virtual TClassIsA () const
 
void SetDEDw (Double_t DEDw)
 
void SetLearningRate (Double_t rate)
 
void SetPostNeuron (TNeuron *post)
 
void SetPreNeuron (TNeuron *pre)
 
void SetWeight (Double_t weight)
 set synapse weight
 
virtual void Streamer (TBuffer &)
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor.
 
 TObject (const TObject &object)
 TObject copy ctor.
 
virtual ~TObject ()
 TObject destructor.
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract.
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad.
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action.
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs.
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility.
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method.
 
virtual void Copy (TObject &object) const
 Copy this to obj.
 
virtual void Delete (Option_t *option="")
 Delete this object.
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects.
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs.
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
 
virtual void Dump () const
 Dump contents of object on stdout.
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message.
 
virtual void Execute (const char *method, const char *params, Int_t *error=nullptr)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 Execute method on this object with parameters stored in the TObjArray.
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py).
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
 
virtual const char * GetIconName () const
 Returns mime type name of object.
 
virtual const char * GetName () const
 Returns name of object.
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object.
 
virtual UInt_t GetUniqueID () const
 Return the unique object id.
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
 
virtual ULong_t Hash () const
 Return hash value for this object.
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message.
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname".
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl.
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
 
void InvertBit (UInt_t f)
 
Bool_t IsDestructed () const
 IsDestructed.
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory).
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout.
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification.
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete.
 
void operator delete (void *ptr)
 Operator delete.
 
void operator delete[] (void *ptr)
 Operator delete [].
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *vp)
 
void * operator new[] (size_t sz)
 
void * operator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator.
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself.
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself.
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list.
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out".
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f.
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
 
static Bool_t GetObjectStat ()
 Get status of object stat flag.
 
static void SetDtorOnly (void *obj)
 Set destructor only flag.
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.
 

Private Member Functions

MsgLoggerLog () const
 

Private Attributes

Int_t fCount
 number of updates contributing to error field
 
Double_t fDEDw
 sum of deltas
 
Double_t fDelta
 local error field
 
Double_t fLearnRate
 learning rate parameter
 
TNeuronfPostNeuron
 pointer to post-neuron
 
TNeuronfPreNeuron
 pointer to pre-neuron
 
Double_t fWeight
 weight of the synapse
 

Additional Inherited Members

- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }
 
enum  EStatusBits {
  kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) ,
  kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 ))
}
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected).
 
void MakeZombie ()
 

#include <TMVA/TSynapse.h>

Inheritance diagram for TMVA::TSynapse:
[legend]

Constructor & Destructor Documentation

◆ TSynapse()

TMVA::TSynapse::TSynapse ( )

constructor

Definition at line 46 of file TSynapse.cxx.

◆ ~TSynapse()

TMVA::TSynapse::~TSynapse ( )
virtual

destructor

Definition at line 61 of file TSynapse.cxx.

Member Function Documentation

◆ AdjustWeight()

void TMVA::TSynapse::AdjustWeight ( )

adjust the weight based on the error field all ready calculated by CalculateDelta

Definition at line 98 of file TSynapse.cxx.

◆ CalculateDelta()

void TMVA::TSynapse::CalculateDelta ( )

calculate/adjust the error field for this synapse

Definition at line 108 of file TSynapse.cxx.

◆ Class()

static TClass * TMVA::TSynapse::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * TMVA::TSynapse::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t TMVA::TSynapse::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 101 of file TSynapse.h.

◆ DecayLearningRate()

void TMVA::TSynapse::DecayLearningRate ( Double_t  rate)
inline

Definition at line 62 of file TSynapse.h.

◆ DeclFileName()

static const char * TMVA::TSynapse::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 101 of file TSynapse.h.

◆ GetDEDw()

Double_t TMVA::TSynapse::GetDEDw ( )
inline

Definition at line 86 of file TSynapse.h.

◆ GetDelta()

Double_t TMVA::TSynapse::GetDelta ( )
inline

Definition at line 87 of file TSynapse.h.

◆ GetLearningRate()

Double_t TMVA::TSynapse::GetLearningRate ( )
inline

Definition at line 59 of file TSynapse.h.

◆ GetWeight()

Double_t TMVA::TSynapse::GetWeight ( )
inline

Definition at line 53 of file TSynapse.h.

◆ GetWeightedDelta()

Double_t TMVA::TSynapse::GetWeightedDelta ( )

get error field of post-neuron weighted by synapse weight

Definition at line 87 of file TSynapse.cxx.

◆ GetWeightedValue()

Double_t TMVA::TSynapse::GetWeightedValue ( )

get output of pre-neuron weighted by synapse weight

Definition at line 76 of file TSynapse.cxx.

◆ InitDelta()

void TMVA::TSynapse::InitDelta ( )
inline

Definition at line 83 of file TSynapse.h.

◆ IsA()

virtual TClass * TMVA::TSynapse::IsA ( ) const
inlinevirtual
Returns
TClass describing current object

Reimplemented from TObject.

Definition at line 101 of file TSynapse.h.

◆ Log()

TMVA::MsgLogger & TMVA::TSynapse::Log ( ) const
private

Definition at line 116 of file TSynapse.cxx.

◆ SetDEDw()

void TMVA::TSynapse::SetDEDw ( Double_t  DEDw)
inline

Definition at line 85 of file TSynapse.h.

◆ SetLearningRate()

void TMVA::TSynapse::SetLearningRate ( Double_t  rate)
inline

Definition at line 56 of file TSynapse.h.

◆ SetPostNeuron()

void TMVA::TSynapse::SetPostNeuron ( TNeuron post)
inline

Definition at line 68 of file TSynapse.h.

◆ SetPreNeuron()

void TMVA::TSynapse::SetPreNeuron ( TNeuron pre)
inline

Definition at line 65 of file TSynapse.h.

◆ SetWeight()

void TMVA::TSynapse::SetWeight ( Double_t  weight)

set synapse weight

Definition at line 68 of file TSynapse.cxx.

◆ Streamer()

virtual void TMVA::TSynapse::Streamer ( TBuffer R__b)
virtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TMVA::TSynapse::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 101 of file TSynapse.h.

Member Data Documentation

◆ fCount

Int_t TMVA::TSynapse::fCount
private

number of updates contributing to error field

Definition at line 95 of file TSynapse.h.

◆ fDEDw

Double_t TMVA::TSynapse::fDEDw
private

sum of deltas

Definition at line 94 of file TSynapse.h.

◆ fDelta

Double_t TMVA::TSynapse::fDelta
private

local error field

Definition at line 93 of file TSynapse.h.

◆ fLearnRate

Double_t TMVA::TSynapse::fLearnRate
private

learning rate parameter

Definition at line 92 of file TSynapse.h.

◆ fPostNeuron

TNeuron* TMVA::TSynapse::fPostNeuron
private

pointer to post-neuron

Definition at line 97 of file TSynapse.h.

◆ fPreNeuron

TNeuron* TMVA::TSynapse::fPreNeuron
private

pointer to pre-neuron

Definition at line 96 of file TSynapse.h.

◆ fWeight

Double_t TMVA::TSynapse::fWeight
private

weight of the synapse

Definition at line 91 of file TSynapse.h.

Libraries for TMVA::TSynapse:

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