context-dep-itf.h
5.02 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
// itf/context-dep-itf.h
// Copyright 2009-2011 Microsoft Corporation; Go Vivace Inc.
// See ../../COPYING for clarification regarding multiple authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// THIS CODE IS PROVIDED *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
// WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
// MERCHANTABLITY OR NON-INFRINGEMENT.
// See the Apache 2 License for the specific language governing permissions and
// limitations under the License.
#ifndef KALDI_ITF_CONTEXT_DEP_ITF_H_
#define KALDI_ITF_CONTEXT_DEP_ITF_H_
#include "base/kaldi-common.h"
namespace kaldi {
/// @ingroup tree_group
/// @{
/// context-dep-itf.h provides a link between
/// the tree-building code in ../tree/, and the FST code in ../fstext/
/// (particularly, ../fstext/context-dep.h). It is an abstract
/// interface that describes an object that can map from a
/// phone-in-context to a sequence of integer leaf-ids.
class ContextDependencyInterface {
public:
/// ContextWidth() returns the value N (e.g. 3 for triphone models) that says how many phones
/// are considered for computing context.
virtual int ContextWidth() const = 0;
/// Central position P of the phone context, in 0-based numbering, e.g. P = 1 for typical
/// triphone system. We have to see if we can do without this function.
virtual int CentralPosition() const = 0;
/// The "new" Compute interface. For typical topologies,
/// pdf_class would be 0, 1, 2.
/// Returns success or failure; outputs the pdf-id.
///
/// "Compute" is the main function of this interface, that takes a
/// sequence of N phones (and it must be N phones), possibly
/// including epsilons (symbol id zero) but only at positions other
/// than P [these represent unknown phone context due to end or
/// begin of sequence]. We do not insist that Compute must always
/// output (into stateseq) a nonempty sequence of states, but we
/// anticipate that stateseq will alyway be nonempty at output in
/// typical use cases. "Compute" returns false if expansion somehow
/// failed. Normally the calling code should raise an exception if
/// this happens. We can define a different interface later in
/// order to handle other kinds of information-- the underlying
/// data-structures from event-map.h are very flexible.
virtual bool Compute(const std::vector<int32> &phoneseq, int32 pdf_class,
int32 *pdf_id) const = 0;
/// GetPdfInfo returns a vector indexed by pdf-id, saying for each pdf which
/// pairs of (phone, pdf-class) it can correspond to. (Usually just one).
/// c.f. hmm/hmm-topology.h for meaning of pdf-class.
/// This is the old, simpler interface of GetPdfInfo(), and that this one can
/// only be called if the HmmTopology object's IsHmm() function call returns
/// true.
virtual void GetPdfInfo(
const std::vector<int32> &phones, // list of phones
const std::vector<int32> &num_pdf_classes, // indexed by phone,
std::vector<std::vector<std::pair<int32, int32> > > *pdf_info)
const = 0;
/// This function outputs information about what possible pdf-ids can
/// be generated for HMM-states; it covers the general case where
/// the self-loop pdf-class may be different from the forward-transition
/// pdf-class, so we are asking not about the set of possible pdf-ids
/// for a given (phone, pdf-class), but the set of possible ordered pairs
/// (forward-transition-pdf, self-loop-pdf) for a given (phone,
/// forward-transition-pdf-class, self-loop-pdf-class).
/// Note: 'phones' is a list of integer ids of phones, and
/// 'pdf-class-pairs', indexed by phone, is a list of pairs
/// (forward-transition-pdf-class, self-loop-pdf-class) that we can have for
/// that phone.
/// The output 'pdf_info' is indexed first by phone and then by the
/// same index that indexes each element of 'pdf_class_pairs',
/// and tells us for each pair in 'pdf_class_pairs', what is the
/// list of possible (forward-transition-pdf-id, self-loop-pdf-id) that
/// we can have.
/// This is less efficient than the other version of GetPdfInfo().
virtual void GetPdfInfo(
const std::vector<int32> &phones,
const std::vector<std::vector<std::pair<int32, int32> > > &pdf_class_pairs,
std::vector<std::vector<std::vector<std::pair<int32, int32> > > > *pdf_info)
const = 0;
/// NumPdfs() returns the number of acoustic pdfs (they are numbered 0.. NumPdfs()-1).
virtual int32 NumPdfs() const = 0;
virtual ~ContextDependencyInterface() {};
ContextDependencyInterface() {}
/// Returns pointer to new object which is copy of current one.
virtual ContextDependencyInterface *Copy() const = 0;
private:
KALDI_DISALLOW_COPY_AND_ASSIGN(ContextDependencyInterface);
};
/// @}
} // namespace Kaldi
#endif