Index Struct Reference

struct Index is intended to represent the various indexes by which we number the rows of the matrices that the Components process: mainly 'n', the index of the member of the minibatch, 't', used for the frame index in speech recognition, and 'x', which is a catch-all extra index which we might use in convolutional setups or for other reasons. More...

#include <nnet-common.h>

Collaboration diagram for Index:

Public Member Functions
	Index ()
	Index (int32 n, int32 t, int32 x=0)
bool	operator== (const Index &a) const
bool	operator!= (const Index &a) const
bool	operator< (const Index &a) const
Index	operator+ (const Index &other) const
Index &	operator+= (const Index &other)
void	Write (std::ostream &os, bool binary) const
void	Read (std::istream &os, bool binary)

Public Attributes
int32	n
int32	t
int32	x

Detailed Description

struct Index is intended to represent the various indexes by which we number the rows of the matrices that the Components process: mainly 'n', the index of the member of the minibatch, 't', used for the frame index in speech recognition, and 'x', which is a catch-all extra index which we might use in convolutional setups or for other reasons.

It is possible to extend this by adding new indexes if needed.

Definition at line 44 of file nnet-common.h.

Constructor & Destructor Documentation

Index() [1/2]

Index ( )

inline

Definition at line 49 of file nnet-common.h.

Referenced by Index::operator+().

: n(0), t(0), x(0) { }

Index() [2/2]

Index ( int32  n, int32  t, int32  x = 0  )

inline

Definition at line 50 of file nnet-common.h.

: n(n), t(t), x(x) { }

Member Function Documentation

operator!=()

bool operator!= ( const Index &  a ) const

inline

Definition at line 55 of file nnet-common.h.

References Index::n, Index::t, and Index::x.

                                          {
    return n != a.n || t != a.t || x != a.x;
  }

operator+()

Index operator+ ( const Index &  other ) const

inline

Definition at line 65 of file nnet-common.h.

References Index::Index(), Index::n, Index::t, and Index::x.

                                              {
    return Index(n+other.n, t+other.t, x+other.x);
  }

operator+=()

Index& operator+= ( const Index &  other )

inline

Definition at line 68 of file nnet-common.h.

References kaldi::nnet3::kNoTime, Index::n, Index::Read(), Index::t, Index::Write(), and Index::x.

                                          {
    n += other.n;
    t += other.t;
    x += other.x;
    return *this;
  }

operator<()

bool operator< ( const Index &  a ) const

inline

Definition at line 58 of file nnet-common.h.

References Index::n, Index::t, and Index::x.

                                         {
    if (t < a.t) { return true; }
    else if (t > a.t) { return false; }
    else if (x < a.x) { return true; }
    else if (x > a.x) { return false; }
    else return (n < a.n);
  }

operator==()

bool operator== ( const Index &  a ) const

inline

Definition at line 52 of file nnet-common.h.

References Index::n, Index::t, and Index::x.

                                          {
    return n == a.n && t == a.t && x == a.x;
  }

Read()

void Read	(	std::istream &	os,
		bool	binary
	)

Definition at line 37 of file nnet-common.cc.

References kaldi::nnet3::ExpectToken(), Index::n, kaldi::ReadBasicType(), Index::t, and Index::x.

Referenced by Index::operator+=().

                                            {
  ExpectToken(is, binary, "<I1>");
  ReadBasicType(is, binary, &n);
  ReadBasicType(is, binary, &t);
  ReadBasicType(is, binary, &x);
}

Write()

void Write	(	std::ostream &	os,
		bool	binary
	)		const

Definition at line 27 of file nnet-common.cc.

References Index::n, Index::t, kaldi::WriteBasicType(), kaldi::WriteToken(), and Index::x.

Referenced by Index::operator+=(), and kaldi::nnet3::WriteIndexVector().

                                                   {
  // writing this token will make it easier to write back-compatible code later
  // on.
  WriteToken(os, binary, "<I1>");
  WriteBasicType(os, binary, n);
  WriteBasicType(os, binary, t);
  WriteBasicType(os, binary, x);
}

Member Data Documentation

n

int32 n

Definition at line 45 of file nnet-common.h.

Referenced by BatchedXvectorComputer::BatchedXvectorComputer(), kaldi::nnet3::ConvertNumNValues(), kaldi::nnet3::time_height_convolution::CreateIndexes(), kaldi::nnet3::FindNStride(), RestrictedAttentionComponent::GetInputIndexes(), TimeHeightConvolutionComponent::GetInputIndexes(), TdnnComponent::GetInputIndexes(), kaldi::nnet3::time_height_convolution::GetRandomConvolutionIndexes(), Index::operator!=(), IndexLessNxt::operator()(), Index::operator+(), Index::operator+=(), Index::operator<(), kaldi::nnet3::operator<<(), Index::operator==(), kaldi::nnet3::PrintIndexes(), Index::Read(), kaldi::nnet3::ReadCindexVectorElementBinary(), kaldi::nnet3::ReadIndexVectorElementBinary(), kaldi::nnet3::UnitTestCindexIo(), Index::Write(), kaldi::nnet3::WriteCindexVectorElementBinary(), and kaldi::nnet3::WriteIndexVectorElementBinary().

t

int32 t

Definition at line 46 of file nnet-common.h.

Referenced by BatchedXvectorComputer::BatchedXvectorComputer(), Compiler::ComputeInputLocationsList(), kaldi::nnet3::time_height_convolution::ConvolveForwardSimple(), kaldi::nnet3::GenRandForwardingDescriptor(), RestrictedAttentionComponent::GetInputIndexes(), StatisticsExtractionComponent::GetInputIndexes(), TimeHeightConvolutionComponent::GetInputIndexes(), StatisticsPoolingComponent::GetInputIndexes(), TdnnComponent::GetInputIndexes(), kaldi::nnet3::time_height_convolution::GetRandomConvolutionIndexes(), RestrictedAttentionComponent::IsComputable(), StatisticsExtractionComponent::IsComputable(), TimeHeightConvolutionComponent::IsComputable(), StatisticsPoolingComponent::IsComputable(), TdnnComponent::IsComputable(), SwitchingForwardingDescriptor::MapToInput(), RoundingForwardingDescriptor::MapToInput(), ReplaceIndexForwardingDescriptor::MapToInput(), Index::operator!=(), IndexLessNxt::operator()(), Index::operator+(), Index::operator+=(), Index::operator<(), kaldi::nnet3::operator<<(), Index::operator==(), StatisticsExtractionComponent::PrecomputeIndexes(), StatisticsPoolingComponent::PrecomputeIndexes(), kaldi::nnet3::PrintIndexes(), Index::Read(), kaldi::nnet3::ReadCindexVectorElementBinary(), kaldi::nnet3::ReadIndexVectorElementBinary(), kaldi::nnet3::UnitTestCindexIo(), Index::Write(), kaldi::nnet3::WriteCindexVectorElementBinary(), and kaldi::nnet3::WriteIndexVectorElementBinary().

x

int32 x

Definition at line 47 of file nnet-common.h.

Referenced by DistributeComponent::ComputeInputIndexAndBlock(), kaldi::nnet3::GenRandForwardingDescriptor(), RestrictedAttentionComponent::GetInputIndexes(), TimeHeightConvolutionComponent::GetInputIndexes(), TdnnComponent::GetInputIndexes(), kaldi::nnet3::time_height_convolution::GetRandomConvolutionIndexes(), ReplaceIndexForwardingDescriptor::MapToInput(), Index::operator!=(), IndexLessNxt::operator()(), Index::operator+(), Index::operator+=(), Index::operator<(), kaldi::nnet3::operator<<(), Index::operator==(), kaldi::nnet3::PrintIndexes(), Index::Read(), kaldi::nnet3::ReadCindexVectorElementBinary(), kaldi::nnet3::ReadIndexVectorElementBinary(), kaldi::nnet3::UnitTestCindexIo(), Index::Write(), kaldi::nnet3::WriteCindexVectorElementBinary(), and kaldi::nnet3::WriteIndexVectorElementBinary().

---

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

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