Logo ROOT  
Reference Guide
TSynapse Class Reference

This is a simple weighted bidirectional connection between two neurons. A network is built connecting two neurons by a synapse. In addition to the value, the synapse can return the DeDw

Definition at line 20 of file TSynapse.h.

Public Member Functions

 TSynapse ()
 Default constructor. More...
 
 TSynapse (TNeuron *, TNeuron *, Double_t w=1)
 Constructor that connects two neurons. More...
 
virtual ~TSynapse ()
 
Double_t GetDeDw () const
 Computes the derivative of the error wrt the synapse weight. More...
 
Double_t GetDEDw () const
 
TNeuronGetPost () const
 
TNeuronGetPre () const
 
Double_t GetValue () const
 Returns the value: weighted input. More...
 
Double_t GetWeight () const
 
void SetDEDw (Double_t in)
 Sets the derivative of the total error wrt the synapse weight. More...
 
void SetPost (TNeuron *post)
 Sets the post-neuron. More...
 
void SetPre (TNeuron *pre)
 Sets the pre-neuron. More...
 
void SetWeight (Double_t w)
 Sets the weight of the synapse. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
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. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
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. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
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. More...
 
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). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
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. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Private Attributes

Double_t fDEDw
 ! the derivative of the total error wrt the synapse weight More...
 
TNeuronfpost
 the neuron after the synapse More...
 
TNeuronfpre
 the neuron before the synapse More...
 
Double_t fweight
 the weight of the synapse More...
 

Additional Inherited Members

- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kInconsistent = 0x08000000,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- 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). More...
 
void MakeZombie ()
 

#include <TMVA/TSynapse.h>

Inheritance diagram for TSynapse:
[legend]

Constructor & Destructor Documentation

◆ TSynapse() [1/2]

TSynapse::TSynapse ( )

Default constructor.

Definition at line 29 of file TSynapse.cxx.

◆ TSynapse() [2/2]

TSynapse::TSynapse ( TNeuron pre,
TNeuron post,
Double_t  w = 1 
)

Constructor that connects two neurons.

Definition at line 40 of file TSynapse.cxx.

◆ ~TSynapse()

virtual TSynapse::~TSynapse ( )
inlinevirtual

Definition at line 24 of file TSynapse.h.

Member Function Documentation

◆ GetDeDw()

Double_t TSynapse::GetDeDw ( ) const

Computes the derivative of the error wrt the synapse weight.

Definition at line 89 of file TSynapse.cxx.

◆ GetDEDw()

Double_t TSynapse::GetDEDw ( ) const
inline

Definition at line 34 of file TSynapse.h.

◆ GetPost()

TNeuron* TSynapse::GetPost ( ) const
inline

Definition at line 28 of file TSynapse.h.

◆ GetPre()

TNeuron* TSynapse::GetPre ( ) const
inline

Definition at line 27 of file TSynapse.h.

◆ GetValue()

Double_t TSynapse::GetValue ( ) const

Returns the value: weighted input.

Definition at line 79 of file TSynapse.cxx.

◆ GetWeight()

Double_t TSynapse::GetWeight ( ) const
inline

Definition at line 30 of file TSynapse.h.

◆ SetDEDw()

void TSynapse::SetDEDw ( Double_t  in)

Sets the derivative of the total error wrt the synapse weight.

Definition at line 110 of file TSynapse.cxx.

◆ SetPost()

void TSynapse::SetPost ( TNeuron post)

Sets the post-neuron.

Definition at line 66 of file TSynapse.cxx.

◆ SetPre()

void TSynapse::SetPre ( TNeuron pre)

Sets the pre-neuron.

Definition at line 53 of file TSynapse.cxx.

◆ SetWeight()

void TSynapse::SetWeight ( Double_t  w)

Sets the weight of the synapse.

This weight is the multiplying factor applied on the output of a neuron in the linear combination given as input of another neuron.

Definition at line 102 of file TSynapse.cxx.

Member Data Documentation

◆ fDEDw

Double_t TSynapse::fDEDw
private

! the derivative of the total error wrt the synapse weight

Definition at line 40 of file TSynapse.h.

◆ fpost

TNeuron* TSynapse::fpost
private

the neuron after the synapse

Definition at line 38 of file TSynapse.h.

◆ fpre

TNeuron* TSynapse::fpre
private

the neuron before the synapse

Definition at line 37 of file TSynapse.h.

◆ fweight

Double_t TSynapse::fweight
private

the weight of the synapse

Definition at line 39 of file TSynapse.h.

Libraries for TSynapse:
[legend]

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