summaryrefslogtreecommitdiff
path: root/kaldi_io/src/kaldi/matrix/tp-matrix.h
blob: f43e86c3d7b20ddbe2858151c3b86a4093450218 (plain) (blame)
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
// matrix/tp-matrix.h

// Copyright 2009-2011  Ondrej Glembek;  Lukas Burget;  Microsoft Corporation;
//                      Saarland University;  Yanmin Qian;   Haihua Xu
//                2013  Johns Hopkins Universith (author: Daniel Povey)


// 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_MATRIX_TP_MATRIX_H_
#define KALDI_MATRIX_TP_MATRIX_H_


#include "matrix/packed-matrix.h"

namespace kaldi {
/// \addtogroup matrix_group
/// @{

template<typename Real> class TpMatrix;

/// @brief Packed symetric matrix class
template<typename Real>
class TpMatrix : public PackedMatrix<Real> {
  friend class CuTpMatrix<float>;
  friend class CuTpMatrix<double>;
 public:
  TpMatrix() : PackedMatrix<Real>() {}
  explicit TpMatrix(MatrixIndexT r, MatrixResizeType resize_type = kSetZero)
      : PackedMatrix<Real>(r, resize_type) {}
  TpMatrix(const TpMatrix<Real>& orig) : PackedMatrix<Real>(orig) {}

  /// Copy constructor from CUDA TpMatrix
  /// This is defined in ../cudamatrix/cu-tp-matrix.cc
  explicit TpMatrix(const CuTpMatrix<Real> &cu);
  
  
  template<typename OtherReal> explicit TpMatrix(const TpMatrix<OtherReal>& orig)
      : PackedMatrix<Real>(orig) {}
  
  Real operator() (MatrixIndexT r, MatrixIndexT c) const {
    if (static_cast<UnsignedMatrixIndexT>(c) >
        static_cast<UnsignedMatrixIndexT>(r)) {
      KALDI_ASSERT(static_cast<UnsignedMatrixIndexT>(c) <
                   static_cast<UnsignedMatrixIndexT>(this->num_rows_));
      return 0;
    }
    KALDI_ASSERT(static_cast<UnsignedMatrixIndexT>(r) <
                 static_cast<UnsignedMatrixIndexT>(this->num_rows_));
    // c<=r now so don't have to check c.
    return *(this->data_ + (r*(r+1)) / 2 + c);
    // Duplicating code from PackedMatrix.h
  }

  Real &operator() (MatrixIndexT r, MatrixIndexT c) {
    KALDI_ASSERT(static_cast<UnsignedMatrixIndexT>(r) <
                 static_cast<UnsignedMatrixIndexT>(this->num_rows_));
    KALDI_ASSERT(static_cast<UnsignedMatrixIndexT>(c) <=
                 static_cast<UnsignedMatrixIndexT>(r) &&
                 "you cannot access the upper triangle of TpMatrix using "
                 "a non-const matrix object.");
    return *(this->data_ + (r*(r+1)) / 2 + c);
    // Duplicating code from PackedMatrix.h
  }
  // Note: Cholesky may throw std::runtime_error
  void Cholesky(const SpMatrix<Real>& orig);
  
  void Invert();

  // Inverts in double precision.
  void InvertDouble() {
    TpMatrix<double> dmat(*this);
    dmat.Invert();
    (*this).CopyFromTp(dmat);
  }

  /// Shallow swap
  void Swap(TpMatrix<Real> *other);

  /// Returns the determinant of the matrix (product of diagonals)
  Real Determinant();

  /// CopyFromMat copies the lower triangle of M into *this
  /// (or the upper triangle, if Trans == kTrans).
  void CopyFromMat(const MatrixBase<Real> &M,
                   MatrixTransposeType Trans = kNoTrans);

  /// This is implemented in ../cudamatrix/cu-tp-matrix.cc
  void CopyFromMat(const CuTpMatrix<Real> &other);
  
  /// CopyFromTp copies another triangular matrix into this one.
  void CopyFromTp(const TpMatrix<Real> &other) {
    PackedMatrix<Real>::CopyFromPacked(other);
  }

  template<typename OtherReal> void CopyFromTp(const TpMatrix<OtherReal> &other) {
    PackedMatrix<Real>::CopyFromPacked(other);
  }

  /// AddTp does *this += alpha * M.
  void AddTp(const Real alpha, const TpMatrix<Real> &M) {
    this->AddPacked(alpha, M);
  }

  using PackedMatrix<Real>::operator =;
  using PackedMatrix<Real>::Scale;

  void Resize(MatrixIndexT nRows, MatrixResizeType resize_type = kSetZero) {
    PackedMatrix<Real>::Resize(nRows, resize_type);
  }
};

/// @} end of "addtogroup matrix_group".

}  // namespace kaldi


#endif