source: trunk/yat/omic/phred.h @ 3325

#ifndef theplu_yat_omic_phred
#define theplu_yat_omic_phred

// $Id: phred.h 3325 2014-10-07 01:44:54Z peter $

/*
  Copyright (C) 2014 Peter Johansson

  This file is part of the yat library, http://dev.thep.lu.se/yat

  The yat library is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 3 of the
  License, or (at your option) any later version.

  The yat library 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
  General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with yat. If not, see <http://www.gnu.org/licenses/>.
*/

namespace theplu {
namespace yat {
namespace omic {

  /**
     Phred scaled probability is defined as \f$ \textrm{Phred} = -10
     \log_{10} (x) \f$

     \return phred scaled probability

     \since New in yat 0.13

     \see phred_inv
   */
  double phred(double p);


  /**
     The inverse of Phred scaling is calculated as \f$ 10^{-x/10} \f$

     \return inverse of Phred scaling

     \since New in yat 0.13

     \see phred
   */
  double phred_inv(double x);

}}}
#endif