clusterable-itf.h

Go to the documentation of this file.

// itf/clusterable-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_CLUSTERABLE_ITF_H_
#define KALDI_ITF_CLUSTERABLE_ITF_H_ 1

#include <string>
#include "base/kaldi-common.h"

namespace kaldi {


class Clusterable {
 public:

  virtual Clusterable *Copy() const = 0;
  virtual BaseFloat Objf() const = 0;
  virtual BaseFloat Normalizer() const = 0;
  virtual void SetZero() = 0;
  virtual void Add(const Clusterable &other) = 0;
  virtual void Sub(const Clusterable &other) = 0;
  virtual void Scale(BaseFloat f) {
    KALDI_ERR << "This Clusterable object does not implement Scale().";
  }

  virtual std::string Type() const = 0;

  virtual void Write(std::ostream &os, bool binary) const = 0;

  virtual Clusterable* ReadNew(std::istream &os, bool binary) const = 0;

  virtual ~Clusterable() {}



  // These functions have default implementations (but may be overridden for
  // speed). Implementatons in tree/clusterable-classes.cc

  virtual BaseFloat ObjfPlus(const Clusterable &other) const;
  virtual BaseFloat ObjfMinus(const Clusterable &other) const;
  virtual BaseFloat Distance(const Clusterable &other) const;

};

}  // end namespace kaldi

#endif  // KALDI_ITF_CLUSTERABLE_ITF_H_