/* The file numbtrop.h contains prototypes to the container for managing
 * numerically computed tropisms.
 * By default, compilation with gcc is assumed.
 * To compile with a C++ compiler such as g++, the flag compilewgpp must
 * be defined as "g++ -Dcompilewgpp=1." */

#ifndef __NUMBTROP_H__
#define __NUMBTROP_H__

#ifdef compilewgpp
extern "C" void adainit( void );
extern "C" int _ada_use_c2phc4c ( int task, int *a, int *b, double *c );
extern "C" void adafinal( void );
#else
extern void adainit( void );
extern int _ada_use_c2phc4c ( int task, int *a, int *b, double *c );
extern void adafinal( void );
#endif

int numbtrop_standard_initialize
 ( int nbt, int dim, int *wnd, double *dir, double *err );
/*
 * DESCRIPTION :
 *   Initializes the numerical tropisms container,
 *   in standard double precision.
 *
 * ON ENTRY :
 *   nbt     number of tropisms;
 *   dim     length_of_each tropism;
 *   wnd     winding numbers, as many as nbt;
 *   dir     nbt*dim doubles with the coordinates of the tropisms;
 *   err     errors on the tropisms, as many doubles as the value of nbt.
 *
 * ON RETURN :
 *   The failure code, which equals zero if all went well. */

int numbtrop_dobldobl_initialize
 ( int nbt, int dim, int *wnd, double *dir, double *err );
/*
 * DESCRIPTION :
 *   Initializes the numerical tropisms container,
 *   in double double precision.
 *
 * ON ENTRY :
 *   nbt     number of tropisms;
 *   dim     length_of_each tropism;
 *   wnd     winding numbers, as many as nbt;
 *   dir     2*nbt*dim doubles with the coordinates of the tropisms;
 *   err     errors on the tropisms, as many doubles as the value of 2*nbt.
 *
 * ON RETURN :
 *   The failure code, which equals zero if all went well. */

int numbtrop_quaddobl_initialize
 ( int nbt, int dim, int *wnd, double *dir, double *err );
/*
 * DESCRIPTION :
 *   Initializes the numerical tropisms container,
 *   in quad double precision.
 *
 * ON ENTRY :
 *   nbt     number of tropisms;
 *   dim     length_of_each tropism;
 *   wnd     winding numbers, as many as nbt;
 *   dir     4*nbt*dim doubles with the coordinates of the tropisms;
 *   err     errors on the tropisms, as many doubles as the value of 4*nbt.
 *
 * ON RETURN :
 *   The failure code, which equals zero if all went well. */

int numbtrop_standard_retrieve
 ( int nbt, int dim, int *wnd, double *dir, double *err );
/*
 * DESCRIPTION :
 *   Retrieves all tropisms stored in standard double precision.
 *
 * ON ENTRY :
 *   nbt    number of tropisms;
 *   dim    length_of_each tropism.
 *
 * ON RETURN :
 *   wnd    winding numbers, as many as nbt;
 *   dir    nbt*dim doubles with the coordinates of the tropisms;
 *   err    errors on the tropisms, as many doubles as the value of nbt.
 *   The failure code, which equals zero if all went well. */

int numbtrop_dobldobl_retrieve
 ( int nbt, int dim, int *wnd, double *dir, double *err );
/*
 * DESCRIPTION :
 *   Retrieves all tropisms stored in double double precision.
 *
 * ON ENTRY :
 *   nbt    number of tropisms;
 *   dim    length_of_each tropism.
 *
 * ON RETURN :
 *   wnd    winding numbers, as many as nbt;
 *   dir    2*nbt*dim doubles with the coordinates of the tropisms;
 *   err    errors on the tropisms, as many doubles as the value of 2*nbt.
 *   The failure code, which equals zero if all went well. */

int numbtrop_quaddobl_retrieve
 ( int nbt, int dim, int *wnd, double *dir, double *err );
/*
 * DESCRIPTION :
 *   Retrieves all tropisms stored in quad double precision.
 *
 * ON ENTRY :
 *   nbt    number of tropisms;
 *   dim    length_of_each tropism.
 *
 * ON RETURN :
 *   wnd    winding numbers, as many as nbt;
 *   dir    4*nbt*dim doubles with the coordinates of the tropisms;
 *   err    errors on the tropisms, as many doubles as the value of 4*nbt.
 *   The failure code, which equals zero if all went well. */

int numbtrop_standard_size ( int *nbt );
/*
 * DESCRIPTION :
 *   Returns in nbt the number of tropisms, stored in standard double
 *   precision, in the numerical tropisms container. */

int numbtrop_dobldobl_size ( int *nbt );
/*
 * DESCRIPTION :
 *   Returns in nbt the number of tropisms, stored in double double
 *   precision, in the numerical tropisms container. */

int numbtrop_quaddobl_size ( int *nbt );
/*
 * DESCRIPTION :
 *   Returns in nbt the number of tropisms, stored in quad double
 *   precision, in the numerical tropisms container. */

int numbtrop_standard_dimension ( int *dim );
/*
 * DESCRIPTION :
 *   Returns in dim the dimension of the tropisms, stored in standard double
 *   precision, in the numerical tropisms container. */

int numbtrop_dobldobl_dimension ( int *dim );
/*
 * DESCRIPTION :
 *   Returns in dim the dimension of the tropisms, stored in double double
 *   precision, in the numerical tropisms container. */

int numbtrop_quaddobl_dimension ( int *dim );
/*
 * DESCRIPTION :
 *   Returns in dim the dimension of the tropisms, stored in quad double
 *   precision, in the numerical tropisms container. */

int numbtrop_store_standard_tropism
 ( int dim, int idx, int wnd, double *dir, double err );
/*
 * DESCRIPTION :
 *   Stores a tropism given in standard double precision.
 *
 * ON ENTRY :
 *   dim     the length of the tropism vector;
 *   idx     the index of the tropism, indexing starts at one,
 *           and ends at nbt, what is returned by numbtrop_standard_size.
 *   wnd     estimated winding number;
 *   dir     coordinates of the tropisms, as many as dim;
 *   err     the error on the tropism. */

int numbtrop_store_dobldobl_tropism
 ( int dim, int idx, int wnd, double *dir, double *err );
/*
 * DESCRIPTION :
 *   Stores a tropism given in double double precision.
 *
 * ON ENTRY :
 *   dim     the length of the tropism vector;
 *   idx     the index of the tropism, indexing starts at one,
 *           and ends at nbt, what is returned by numbtrop_dobldobl_size.
 *   wnd     estimated winding number;
 *   dir     coordinates of the tropisms, as many as 2*dim;
 *   err     the error on the tropism, two doubles. */

int numbtrop_store_quaddobl_tropism
 ( int dim, int idx, int wnd, double *dir, double *err );
/*
 * DESCRIPTION :
 *   Stores a tropism given in quad double precision.
 *
 * ON ENTRY :
 *   dim     the length of the tropism vector;
 *   idx     the index of the tropism, indexing starts at one,
 *           and ends at nbt, what is returned by numbtrop_quaddobl_size.
 *   wnd     estimated winding number;
 *   dir     coordinates of the tropisms, as many as 4*dim;
 *   err     the error on the tropism, four doubles. */

int numbtrop_standard_retrieve_tropism
 ( int dim, int idx, int *wnd, double *dir, double *err );
/*
 * DESCRIPTION :
 *   Returns one tropism, stored in standard double precision.
 *
 * ON ENTRY :
 *   dim     the length of the tropism vector;
 *   idx     the index of the tropism, indexing starts at one,
 *           and ends at nbt, what is returned by numbtrop_standard_size.
 *
 * ON RETURN :
 *   wnd     estimated winding number;
 *   dir     coordinates of the tropisms, as many as dim;
 *   err     the error on the tropism. */

int numbtrop_dobldobl_retrieve_tropism
 ( int dim, int idx, int *wnd, double *dir, double *err );
/*
 * DESCRIPTION :
 *   Returns one tropism, stored in double double precision.
 *
 * ON ENTRY :
 *   dim     the length of the tropism vector;
 *   idx     the index of the tropism, indexing starts at one,
 *           and ends at nbt, what is returned by numbtrop_dobldobl_size.
 *
 * ON RETURN :
 *   wnd     estimated winding number;
 *   dir     coordinates of the tropisms, as many as 2*dim;
 *   err     the error on the tropism, two doubles. */

int numbtrop_quaddobl_retrieve_tropism
 ( int dim, int idx, int *wnd, double *dir, double *err );
/*
 * DESCRIPTION :
 *   Returns one tropism, stored in quad double precision.
 *
 * ON ENTRY :
 *   dim     the length of the tropism vector;
 *   idx     the index of the tropism, indexing starts at one,
 *           and ends at nbt, what is returned by numbtrop_quaddobl_size.
 *
 * ON RETURN :
 *   wnd     estimated winding number;
 *   dir     coordinates of the tropisms, as many as 4*dim;
 *   err     the error on the tropism, four doubles. */

int numbtrop_standard_clear ( void );
/*
 * DESCRIPTION :
 *   Deallocates the stored numerically computed tropisms,
 *   computed in standard double precision. */

int numbtrop_dobldobl_clear ( void );
/*
 * DESCRIPTION :
 *   Deallocates the stored numerically computed tropisms,
 *   computed in double double precision. */

int numbtrop_quaddobl_clear ( void );
/*
 * DESCRIPTION :
 *   Deallocates the stored numerically computed tropisms,
 *   computed in quad double precision. */

#endif