STK_Reduct_Util.h

Go to the documentation of this file.

/*--------------------------------------------------------------------*/
/*     Copyright (C) 2004-2016  Serge Iovleff, Université Lille 1, Inria
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as
    published by the Free Software Foundation; either version 2 of the
    License, or (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.
 
    You should have received a copy of the GNU Lesser General Public
    License along with this program; if not, write to the
    Free Software Foundation, Inc.,
    59 Temple Place,
    Suite 330,
    Boston, MA 02111-1307
    USA
 
    Contact : S..._Dot_I..._At_stkpp_Dot_org (see copyright for ...)
*/
 
/*
 * Project:  stkpp::Reduct
 * created on: 23 juin 2011
 * Purpose:  enum and other utilities for the Reduct project.
 * Author:   iovleff, S..._Dot_I..._At_stkpp_Dot_org (see copyright for ...)
 *
 **/
 
#ifndef STK_REDUCT_UTIL_H_
#define STK_REDUCT_UTIL_H_
 
#include <STKernel.h>
 
namespace STK
{
 
namespace Reduct
{
 
enum TypeReduction
{
  unknown_reduction_ =0
  , localVariance_
  , totalVariance_
  , mds_
};
 
TypeReduction stringToTypeReduction( String const& type);
 
String typeReductionToString( TypeReduction const& type);
 
enum TypeGraph { unknown_graph_, prim_, distance_ };
TypeGraph stringToTypeGraph( String const& type);
String typeGraphToString( TypeGraph const& type);
} // namespace Reduct
 
namespace Reduct
{
 
/* convert a String to a TypeReduction.
 *  @param type the type of reduction we want to define
 *  @return the TypeReduction represented by the String @c type. if the string
 *  does not match any known name, the @c unknown_ type is returned.
 **/
inline TypeReduction stringToTypeReduction( String const& type)
{
  if (toUpperString(type) == toUpperString(_T("totalVariance")))  return totalVariance_;
  if (toUpperString(type) == toUpperString(_T("localVariance"))) return localVariance_;
  if (toUpperString(type) == toUpperString(_T("mds"))) return mds_;
  return unknown_reduction_;
}
 
/* convert a TypeReduction to a String.
 *  @param type the type of reduction we want to convert
 *  @return the string associated to this type.
 **/
inline String typeReductionToString( TypeReduction const& type)
{
  if (type == totalVariance_)  return String(_T("totalVariance"));
  if (type == localVariance_) return String(_T("localVariance"));
  if (type == mds_) return String(_T("mds"));
  return String(_T("unknown"));
}
 
/* convert a String to a TypeReduction.
 *  @param type the type of reduction we want to define
 *  @return the TypeReduction represented by the String @c type. if the string
 *  does not match any known name, the @c unknown_ type is returned.
 **/
inline TypeGraph stringToTypeGraph( String const& type)
{
  if (toUpperString(type) == toUpperString(_T("prim")))  return prim_;
  if (toUpperString(type) == toUpperString(_T("minimalDistance"))) return distance_;
  return unknown_graph_;
}
 
/* convert a TypeReduction to a String.
 *  @param type the type of reduction we want to convert
 *  @return the string associated to this type.
 **/
inline String typeGraphToString( TypeGraph const& type)
{
  if (type == prim_)  return String(_T("prim"));
  if (type == distance_) return String(_T("minimalDistance"));
  return String(_T("unknown"));
}
 
} // namespace Reduct
 
} // namespace STK
 
#endif /* STK_REDUCT_UTIL_H_ */