SimpleSumDescriptor Class Reference

This is the normal base-case of SumDescriptor which just wraps a ForwardingDescriptor. More...

#include <nnet-descriptor.h>

Inheritance diagram for SimpleSumDescriptor:

Collaboration diagram for SimpleSumDescriptor:

Public Member Functions
virtual void	GetDependencies (const Index &ind, std::vector< Cindex > *dependencies) const
	Given an Index at the output of this Descriptor, append to "dependencies" a list of Cindexes that describes what inputs we potentially depend on. More...
virtual bool	IsComputable (const Index &ind, const CindexSet &cindex_set, std::vector< Cindex > *used_inputs) const
	This function exists to enable us to manage optional dependencies, i.e. More...
virtual int32	Dim (const Nnet &nnet) const
virtual BaseFloat	GetScaleForNode (int32 node_index) const
	This function returns the scale on the node-index 'node_index' when it appears in expressions inside this descriptor. More...
virtual void	GetNodeDependencies (std::vector< int32 > *node_indexes) const
	This function appends to "node_indexes" a list (not necessarily sorted or unique) of all the node indexes that this descriptor may forward data from. More...
virtual int32	Modulus () const
virtual void	WriteConfig (std::ostream &os, const std::vector< std::string > &node_names) const
	written form is: if required_ == true, "<written-form-of-src>" else "IfDefined(<written-form-of-src>)". More...
virtual SumDescriptor *	Copy () const
	SimpleSumDescriptor (ForwardingDescriptor *src)
virtual	~SimpleSumDescriptor ()
const ForwardingDescriptor &	Src () const
Public Member Functions inherited from SumDescriptor
virtual	~SumDescriptor ()

Private Attributes
ForwardingDescriptor *	src_

Detailed Description

This is the normal base-case of SumDescriptor which just wraps a ForwardingDescriptor.

The written form is any valid ForwardingDescriptor, e.g. in the simplest case just `tdnn3`. See also ConstantSumDescriptor().

Definition at line 416 of file nnet-descriptor.h.

Constructor & Destructor Documentation

SimpleSumDescriptor()

SimpleSumDescriptor ( ForwardingDescriptor *  src )

inline

Definition at line 437 of file nnet-descriptor.h.

: src_(src) { }

~SimpleSumDescriptor()

virtual ~SimpleSumDescriptor ( )

inlinevirtual

Definition at line 438 of file nnet-descriptor.h.

{ delete src_; }

Member Function Documentation

Copy()

SumDescriptor * Copy ( ) const

virtual

Implements SumDescriptor.

Definition at line 294 of file nnet-descriptor.cc.

                                               {
  return new SimpleSumDescriptor(src_->Copy());
}

Dim()

int32 Dim ( const Nnet &  nnet ) const

virtual

Implements SumDescriptor.

Definition at line 320 of file nnet-descriptor.cc.

                                                     {
  return src_->Dim(nnet);
}

GetDependencies()

void GetDependencies ( const Index &  ind, std::vector< Cindex > *  dependencies  ) const

virtual

Given an Index at the output of this Descriptor, append to "dependencies" a list of Cindexes that describes what inputs we potentially depend on.

The output list is not necessarily sorted, and this function doesn't make sure that it's unique.

Implements SumDescriptor.

Definition at line 298 of file nnet-descriptor.cc.

                                                                                 {
  dependencies->push_back(src_->MapToInput(ind));
}

GetNodeDependencies()

void GetNodeDependencies ( std::vector< int32 > *  node_indexes ) const

virtual

This function appends to "node_indexes" a list (not necessarily sorted or unique) of all the node indexes that this descriptor may forward data from.

Implements SumDescriptor.

Definition at line 330 of file nnet-descriptor.cc.

                                          {
  src_->GetNodeDependencies(node_indexes);
}

GetScaleForNode()

BaseFloat GetScaleForNode ( int32  node_index ) const

virtual

This function returns the scale on the node-index 'node_index' when it appears in expressions inside this descriptor.

E.g. if the descriptor is just `Scale(tdnn2, 2.0)` and the node index for `tdnn2` is 4, then GetScaleForNode(4) would return 2.0. It will return +infinity if the node is >= 0 and does not appear in this descriptor. If node_index < 0, it returns the constant offset value from this descriptor, which will equal 0.0 if there is no expression like `Const(1.0, 512)` in this node. If a particular node_index > 0 appears in different sub-expressions of the descriptor with different scales it is an error (it's not supported) and this function would crash.

Implements SumDescriptor.

Definition at line 324 of file nnet-descriptor.cc.

                                                                     {
  if (node_index >= 0) return src_->GetScaleForNode(node_index);
  else return 0.0;  // scale of constant term, which does not appear in
                    // ForwardingDescriptors, hence 0.0.
}

IsComputable()

bool IsComputable ( const Index &  ind, const CindexSet &  cindex_set, std::vector< Cindex > *  used_inputs  ) const

virtual

This function exists to enable us to manage optional dependencies, i.e.

for making sense of expressions like (A + (B is present)) and (A if present; if not, B). Suppose we are trying to compute the index "ind", and the user represents that "cindex_set" is the set of Cindexes are available to the computation; then this function will return true if we can compute the expression given these inputs; and if so, will output to "used_inputs" the list of Cindexes that this expression will be a summation over.

Parameters

[in]	ind	The index that we want to compute at the output of the Descriptor.
[in]	cindex_set	The set of Cindexes that are available at the input of the Descriptor.
[out]	used_inputs	If non-NULL, if this function returns true then to this vector will be *appended* the inputs that will actually participate in the computation. Else (if non-NULL) it will be left unchanged.

Returns

Returns true if this output is computable given the provided inputs.

Implements SumDescriptor.

Definition at line 303 of file nnet-descriptor.cc.

                                          {
  Cindex c = src_->MapToInput(ind);
  bool src_present  = cindex_set(c);
  if (src_present && used_inputs != NULL)
    used_inputs->push_back(c);
  return src_present;
}

Modulus()

virtual int32 Modulus ( ) const

inlinevirtual

Implements SumDescriptor.

Definition at line 430 of file nnet-descriptor.h.

References ForwardingDescriptor::Copy(), and ForwardingDescriptor::WriteConfig().

{ return src_->Modulus(); }

Src()

const ForwardingDescriptor& Src ( ) const

inline

Definition at line 442 of file nnet-descriptor.h.

Referenced by ModelCollapser::SumDescriptorIsCollapsible().

{ return *src_; }

WriteConfig()

void WriteConfig ( std::ostream &  os, const std::vector< std::string > &  node_names  ) const

virtual

written form is: if required_ == true, "<written-form-of-src>" else "IfDefined(<written-form-of-src>)".

Implements SumDescriptor.

Definition at line 314 of file nnet-descriptor.cc.

                                                  {
  src_->WriteConfig(os, node_names);
}

Member Data Documentation

src_

ForwardingDescriptor* src_

private

Definition at line 444 of file nnet-descriptor.h.

---

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

• nnet3/nnet-descriptor.h
• nnet3/nnet-descriptor.cc