binaries/src/ViennaRNA/H/read_epars.h

   1 #ifndef __VIENNA_RNA_PACKAGE_READ_EPARS_H__
   2 #define __VIENNA_RNA_PACKAGE_READ_EPARS_H__
   3
   4 /**
   5  *  \addtogroup energy_parameters_rw
   6  *  \brief  Read and Write energy parameter sets from and to text files
   7  *
   8  *  A default set of parameters, identical to the one described in
   9  *  \cite mathews:2004 and \cite turner:2010, is compiled into the library.
  10  *
  11  *  @{
  12  *  \file read_epars.h
  13  *
  14  */
  15
  16 /**
  17  *  \brief
  18  *
  19  */
  20 enum parset {
  21   UNKNOWN= -1, QUIT,
  22   S, S_H, HP, HP_H, B, B_H, IL, IL_H, MMH, MMH_H, MMI, MMI_H,
  23   MMI1N, MMI1N_H, MMI23, MMI23_H, MMM, MMM_H, MME, MME_H, D5, D5_H, D3, D3_H,
  24   INT11, INT11_H, INT21, INT21_H, INT22, INT22_H, ML, TL,
  25   TRI, HEX, NIN, MISC};
  26
  27 /**
  28  *  \brief Read energy parameters from a file
  29  *
  30  *  \param fname  The path to the file containing the energy parameters
  31  */
  32 void  read_parameter_file(const char fname[]);
  33
  34 /**
  35  *  \brief Write energy parameters to a file
  36  *
  37  *  \param fname  A filename (path) for the file where the current energy parameters will be written to
  38  */
  39 void  write_parameter_file(const char fname[]);
  40
  41 /**
  42  *  \brief
  43  *
  44  */
  45 enum  parset gettype(const char *ident);
  46
  47 /**
  48  *  \brief
  49  *
  50  */
  51 char  *settype(enum parset s);
  52
  53 /**
  54  *  @}
  55  */
  56
  57 #endif