Threshold.hpp

Go to the documentation of this file.

// Copyright (C) 2011 the authors listed below
// http://ecocpak.sourceforge.net
//
// Authors:
// - Dimitrios Bouzas (bouzas at ieee dot org)
// - Nikolaos Arvanitopoulos (niarvani at ieee dot org)
// - Anastasios Tefas (tefas at aiia dot csd dot auth dot gr)
//
// This file is part of the ECOC PAK C++ library. It is
// provided without any warranty of fitness for any purpose.
//
// You can redistribute this file and/or modify it under
// the terms of the GNU Lesser General Public License (LGPL)
// as published by the Free Software Foundation, either
// version 3 of the License or (at your option) any later
// version.
// (see http://www.opensource.org/licenses for more info)





#ifndef _THRESHOLD_H_
#define _THRESHOLD_H_



#include <armadillo>
using namespace arma;



class Threshold
  {
  public:

  // --- Ctors & dtors --- //

  // Default constructor
  Threshold();

  // User defined constructor
  Threshold(const double p, const u32 s, const double im);

  // Copy constructor
  Threshold(const Threshold& t);

  // Default destructor
  ~Threshold();

  // --- Accessors --- //

  // returns minimum cluster's size threshold
  unsigned int Size() const;

  // returns performance threshold
  double Performance() const;

  // returns improvement threshold
  double Improvement() const;

  // --- Mutators --- //

  // sets size threshold
  Threshold& setSize(const u32 s);

  // sets performance threshold
  Threshold& setPerformance(const double p);

  // sets improvements threshold
  Threshold& setImprovement(const double im);

  private:

  // Minimum size for of a subset to be clustered
  u32 size;

  // The minimum error desired for each binary problem
  double performance;

  // Impovement of the splited subset regarding the previous ones
  double improvement;
  };


// --- Ctors & dtors --- //


Threshold::Threshold()
  :
  size(0),
  performance(0.0),
  improvement(0.0)
  {

  }



Threshold::Threshold
  (
  const double p,
  const u32 s,
  const double im
  )
  :
  performance(p),
  size(s),
  improvement(im)
  {

  }



Threshold::Threshold
  (
  const Threshold& t
  )
  {
  size = t.Size();
  performance = t.Performance();
  improvement = t.Improvement();
  }



Threshold::~Threshold ()
  {
  // does nothing
  }


// --- Accessors --- //


inline
unsigned int
Threshold::Size() const
  {
  return size;
  }



inline
double
Threshold::Performance() const
  {
  return performance;
  }



inline
double
Threshold::Improvement() const
  {
  return improvement;
  }


// --- Mutators --- //


inline
Threshold&
Threshold::setSize
  (
  const u32 s
  )
  {
  size = s;
  return *this;
  }



inline
Threshold&
Threshold::setPerformance
  (
  const double p
  )
  {
  performance = p;
  return *this;
  }



inline
Threshold&
Threshold::setImprovement
  (
  const double im
  )
  {
  improvement = im;
  return *this;
  }



#endif