Neuron class used by TMVA artificial neural network methods.

Definition at line 49 of file TNeuron.h.

Public Member Functions
	TNeuron ()
	standard constructor

virtual	~TNeuron ()
	destructor

void	AddPostLink (TSynapse *post)
	add synapse as a post-link to this neuron

void	AddPreLink (TSynapse *pre)
	add synapse as a pre-link to this neuron

void	AdjustSynapseWeights ()
	adjust the pre-synapses' weights for each neuron (input neuron has no pre-synapse) this method should only be called in batch mode

void	CalculateActivationValue ()
	calculate neuron activation/output

void	CalculateDelta ()
	calculate error field

void	CalculateValue ()
	calculate neuron input

void	DeletePreLinks ()
	delete all pre-links

void	ForceValue (Double_t value)
	force the value, typically for input and bias neurons

Double_t	GetActivationValue () const

Double_t	GetDEDw () const

Double_t	GetDelta () const

Double_t	GetValue () const

void	InitSynapseDeltas ()
	initialize the error fields of all pre-neurons this method should only be called in batch mode

Bool_t	IsInputNeuron () const

Bool_t	IsOutputNeuron () const

Int_t	NumPostLinks () const

Int_t	NumPreLinks () const

TSynapse *	PostLinkAt (Int_t index) const

TSynapse *	PreLinkAt (Int_t index) const

virtual void	Print (Option_t *="") const
	This method must be overridden when a class wants to print itself.

void	PrintActivationEqn ()
	print activation equation, for debugging

void	PrintPostLinks () const

void	PrintPreLinks () const

void	SetActivationEqn (TActivation *activation)
	set activation equation

void	SetBiasNeuron ()

void	SetDEDw (Double_t DEDw)

void	SetError (Double_t error)
	set error, this should only be done for an output neuron

void	SetInputCalculator (TNeuronInput *calculator)
	set input calculator

void	SetInputNeuron ()

void	SetOutputNeuron ()

void	UpdateSynapsesBatch ()
	update and adjust the pre-synapses for each neuron (input neuron has no pre-synapse) this method should only be called in batch mode

void	UpdateSynapsesSequential ()
	update the pre-synapses for each neuron (input neuron has no pre-synapse) this method should only be called in sequential mode

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 TObject *	Clone (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 TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad for instance with: `gROOT->SetSelectedPad(gPad)`.

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=0)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=0)
	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 TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () 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_t *	GetOption () 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)

TObject &	operator= (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 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.

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=0, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Private Member Functions
void	DeleteLinksArray (TObjArray *&links)
	delete an array of TSynapses

void	InitNeuron ()
	initialize the neuron, most variables still need to be set via setters

MsgLogger &	Log () const

void	NullifyLinks (TObjArray *&links)

Int_t	NumLinks (TObjArray *links) const

void	PrintLinks (TObjArray *links) const
	print an array of TSynapses, for debugging

void	PrintMessage (EMsgType, TString message)
	print message, for debugging

Private Attributes
TActivation *	fActivation

Double_t	fActivationValue

Double_t	fDEDw

Double_t	fDelta

Double_t	fError

Bool_t	fForcedValue

TNeuronInput *	fInputCalculator

TObjArray *	fLinksIn

TObjArray *	fLinksOut

Double_t	fValue

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 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.

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = BIT(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/TNeuron.h>

Inheritance diagram for TMVA::TNeuron:

[legend]

Constructor & Destructor Documentation

◆ TNeuron()

TMVA::TNeuron::TNeuron ( )

standard constructor

Definition at line 50 of file TNeuron.cxx.

◆ ~TNeuron()

TMVA::TNeuron::~TNeuron ( )

virtual

destructor

Definition at line 58 of file TNeuron.cxx.

Member Function Documentation

◆ AddPostLink()

void TMVA::TNeuron::AddPostLink ( TSynapse * post )

add synapse as a post-link to this neuron

Definition at line 178 of file TNeuron.cxx.

◆ AddPreLink()

void TMVA::TNeuron::AddPreLink ( TSynapse * pre )

add synapse as a pre-link to this neuron

Definition at line 169 of file TNeuron.cxx.

◆ AdjustSynapseWeights()

void TMVA::TNeuron::AdjustSynapseWeights ( )

adjust the pre-synapses' weights for each neuron (input neuron has no pre-synapse) this method should only be called in batch mode

Definition at line 263 of file TNeuron.cxx.

◆ CalculateActivationValue()

void TMVA::TNeuron::CalculateActivationValue ( )

calculate neuron activation/output

Definition at line 102 of file TNeuron.cxx.

◆ CalculateDelta()

void TMVA::TNeuron::CalculateDelta ( )

calculate error field

Definition at line 115 of file TNeuron.cxx.

◆ CalculateValue()

void TMVA::TNeuron::CalculateValue ( )

calculate neuron input

Definition at line 93 of file TNeuron.cxx.

◆ DeleteLinksArray()

void TMVA::TNeuron::DeleteLinksArray ( TObjArray *& links )

private

delete an array of TSynapses

Definition at line 195 of file TNeuron.cxx.

◆ DeletePreLinks()

void TMVA::TNeuron::DeletePreLinks ( )

delete all pre-links

Definition at line 187 of file TNeuron.cxx.

◆ ForceValue()

void TMVA::TNeuron::ForceValue ( Double_t value )

force the value, typically for input and bias neurons

Definition at line 84 of file TNeuron.cxx.

◆ GetActivationValue()

Double_t TMVA::TNeuron::GetActivationValue ( ) const

inline

Definition at line 105 of file TNeuron.h.

◆ GetDEDw()

Double_t TMVA::TNeuron::GetDEDw ( ) const

inline

Definition at line 107 of file TNeuron.h.

◆ GetDelta()

Double_t TMVA::TNeuron::GetDelta ( ) const

inline

Definition at line 106 of file TNeuron.h.

◆ GetValue()

Double_t TMVA::TNeuron::GetValue ( ) const

inline

Definition at line 104 of file TNeuron.h.

◆ InitNeuron()

void TMVA::TNeuron::InitNeuron ( )

private

initialize the neuron, most variables still need to be set via setters

Definition at line 67 of file TNeuron.cxx.

◆ InitSynapseDeltas()

void TMVA::TNeuron::InitSynapseDeltas ( )

initialize the error fields of all pre-neurons this method should only be called in batch mode

Definition at line 283 of file TNeuron.cxx.

◆ IsInputNeuron()

Bool_t TMVA::TNeuron::IsInputNeuron ( ) const

inline

Definition at line 116 of file TNeuron.h.

◆ IsOutputNeuron()

Bool_t TMVA::TNeuron::IsOutputNeuron ( ) const

inline

Definition at line 117 of file TNeuron.h.

◆ Log()

TMVA::MsgLogger & TMVA::TNeuron::Log ( ) const

private

Definition at line 343 of file TNeuron.cxx.

◆ NullifyLinks()

void TMVA::TNeuron::NullifyLinks ( TObjArray *& links )

inlineprivate

Definition at line 139 of file TNeuron.h.

◆ NumLinks()

Int_t TMVA::TNeuron::NumLinks ( TObjArray * links ) const

inlineprivate

Definition at line 135 of file TNeuron.h.

◆ NumPostLinks()

Int_t TMVA::TNeuron::NumPostLinks ( ) const

inline

Definition at line 109 of file TNeuron.h.

◆ NumPreLinks()

Int_t TMVA::TNeuron::NumPreLinks ( ) const

inline

Definition at line 108 of file TNeuron.h.

◆ PostLinkAt()

TSynapse * TMVA::TNeuron::PostLinkAt ( Int_t index ) const

inline

Definition at line 111 of file TNeuron.h.

◆ PreLinkAt()

TSynapse * TMVA::TNeuron::PreLinkAt ( Int_t index ) const

inline

Definition at line 110 of file TNeuron.h.

◆ Print()

virtual void TMVA::TNeuron::Print ( Option_t * option = "" ) const

inlinevirtual

This method must be overridden when a class wants to print itself.

Reimplemented from TObject.

Definition at line 121 of file TNeuron.h.

◆ PrintActivationEqn()

void TMVA::TNeuron::PrintActivationEqn ( )

print activation equation, for debugging

Definition at line 327 of file TNeuron.cxx.

◆ PrintLinks()

void TMVA::TNeuron::PrintLinks ( TObjArray * links ) const

private

print an array of TSynapses, for debugging

Definition at line 303 of file TNeuron.cxx.

◆ PrintMessage()

void TMVA::TNeuron::PrintMessage	(	EMsgType	type,
		TString	message
	)

private

print message, for debugging

Definition at line 336 of file TNeuron.cxx.

◆ PrintPostLinks()

void TMVA::TNeuron::PrintPostLinks ( ) const

inline

Definition at line 119 of file TNeuron.h.

◆ PrintPreLinks()

void TMVA::TNeuron::PrintPreLinks ( ) const

inline

Definition at line 118 of file TNeuron.h.

◆ SetActivationEqn()

void TMVA::TNeuron::SetActivationEqn ( TActivation * activation )

set activation equation

Definition at line 160 of file TNeuron.cxx.

◆ SetBiasNeuron()

void TMVA::TNeuron::SetBiasNeuron ( )

inline

Definition at line 114 of file TNeuron.h.

◆ SetDEDw()

void TMVA::TNeuron::SetDEDw ( Double_t DEDw )

inline

Definition at line 115 of file TNeuron.h.

◆ SetError()

void TMVA::TNeuron::SetError ( Double_t error )

set error, this should only be done for an output neuron

Definition at line 212 of file TNeuron.cxx.

◆ SetInputCalculator()

void TMVA::TNeuron::SetInputCalculator ( TNeuronInput * calculator )

set input calculator

Definition at line 151 of file TNeuron.cxx.

◆ SetInputNeuron()

void TMVA::TNeuron::SetInputNeuron ( )

inline

Definition at line 112 of file TNeuron.h.

◆ SetOutputNeuron()

void TMVA::TNeuron::SetOutputNeuron ( )

inline

Definition at line 113 of file TNeuron.h.

◆ UpdateSynapsesBatch()

void TMVA::TNeuron::UpdateSynapsesBatch ( )

update and adjust the pre-synapses for each neuron (input neuron has no pre-synapse) this method should only be called in batch mode

Definition at line 224 of file TNeuron.cxx.

◆ UpdateSynapsesSequential()

void TMVA::TNeuron::UpdateSynapsesSequential ( )

update the pre-synapses for each neuron (input neuron has no pre-synapse) this method should only be called in sequential mode

Definition at line 242 of file TNeuron.cxx.

Member Data Documentation

◆ fActivation

TActivation* TMVA::TNeuron::fActivation

private

Definition at line 152 of file TNeuron.h.

◆ fActivationValue

Double_t TMVA::TNeuron::fActivationValue

private

Definition at line 147 of file TNeuron.h.

◆ fDEDw

Double_t TMVA::TNeuron::fDEDw

private

Definition at line 149 of file TNeuron.h.

◆ fDelta

Double_t TMVA::TNeuron::fDelta

private

Definition at line 148 of file TNeuron.h.

◆ fError

Double_t TMVA::TNeuron::fError

private

Definition at line 150 of file TNeuron.h.

◆ fForcedValue

Bool_t TMVA::TNeuron::fForcedValue

private

Definition at line 151 of file TNeuron.h.

◆ fInputCalculator

TNeuronInput* TMVA::TNeuron::fInputCalculator

private

Definition at line 153 of file TNeuron.h.

◆ fLinksIn

TObjArray* TMVA::TNeuron::fLinksIn

private

Definition at line 144 of file TNeuron.h.

◆ fLinksOut

TObjArray* TMVA::TNeuron::fLinksOut

private

Definition at line 145 of file TNeuron.h.

◆ fValue

Double_t TMVA::TNeuron::fValue

private

Definition at line 146 of file TNeuron.h.

Libraries for TMVA::TNeuron:

[legend]

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

tmva/tmva/inc/TMVA/TNeuron.h
tmva/tmva/src/TNeuron.cxx

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TNeuron()

◆ ~TNeuron()

Member Function Documentation

◆ AddPostLink()

◆ AddPreLink()

◆ AdjustSynapseWeights()

◆ CalculateActivationValue()

◆ CalculateDelta()

◆ CalculateValue()

◆ DeleteLinksArray()

◆ DeletePreLinks()

◆ ForceValue()

◆ GetActivationValue()

◆ GetDEDw()

◆ GetDelta()

◆ GetValue()

◆ InitNeuron()

◆ InitSynapseDeltas()

◆ IsInputNeuron()

◆ IsOutputNeuron()

◆ Log()

◆ NullifyLinks()

◆ NumLinks()

◆ NumPostLinks()

◆ NumPreLinks()

◆ PostLinkAt()

◆ PreLinkAt()

◆ Print()

◆ PrintActivationEqn()

◆ PrintLinks()

◆ PrintMessage()

◆ PrintPostLinks()

◆ PrintPreLinks()

◆ SetActivationEqn()

◆ SetBiasNeuron()

◆ SetDEDw()

◆ SetError()

◆ SetInputCalculator()

◆ SetInputNeuron()

◆ SetOutputNeuron()

◆ UpdateSynapsesBatch()

◆ UpdateSynapsesSequential()

Member Data Documentation

◆ fActivation

◆ fActivationValue

◆ fDEDw

◆ fDelta

◆ fError

◆ fForcedValue

◆ fInputCalculator

◆ fLinksIn

◆ fLinksOut

◆ fValue