context.h

Go to the documentation of this file.

/*
 * This file is part of MPSolve 3.2.2
 *
 * Copyright (C) 2001-2020, Dipartimento di Matematica "L. Tonelli", Pisa.
 * License: http://www.gnu.org/licenses/gpl.html GPL version 3 or higher
 *
 * Authors:
 *   Leonardo Robol <leonardo.robol@unipi.it>
 */
 
#ifndef MPS_CONTEXT_H
#define MPS_CONTEXT_H
 
#include <mps/mps.h>
#include <pthread.h>
 
#ifdef __cplusplus
extern "C"
{
#endif


typedef void (*mps_mpsolve_ptr)(mps_context *status);

typedef void* (*mps_callback)(mps_context * status, void * user_data);
 
 
/*
 * Macros for casting user functions
 */
#define MPS_FNEWTON_PTR(x) (mps_fnewton_ptr) & (x)
#define MPS_DNEWTON_PTR(x) (mps_dnewton_ptr) & (x)
#define MPS_MNEWTON_PTR(x) (mps_mnewton_ptr) & (x)
#define MPS_CHECK_DATA_PTR(x) (mps_check_data_ptr) & (x)
#define MPS_FSTART_PTR(x) (mps_fstart_ptr) & (x)
#define MPS_DSTART_PTR(x) (mps_dstart_ptr) & (x)
#define MPS_MPSOLVE_PTR(x) (mps_mpsolve_ptr) & (x)
 
/* Properties of the root */
#define MPS_OUTPUT_PROPERTY_NONE      (0x00)
#define MPS_OUTPUT_PROPERTY_REAL      (0x01)
#define MPS_OUTPUT_PROPERTY_IMAGINARY (0x01 << 1)
 
#ifdef _MPS_PRIVATE
struct mps_context {
  mps_boolean error_state;

  char * last_error;

  mps_thread_pool * self_thread_pool;

  mps_boolean resume;

  mps_boolean chkrad;

  mps_callback callback;

  void * user_data;

  mps_operation operation;

  mps_boolean initialized;

  mps_debug_level debug_level;

  mps_boolean over_max;

  mps_input_configuration * input_config;

  mps_output_configuration * output_config;

  int newtis;

  int newtis_old;
 
  /*
   * INPUT / OUTPUT STREAMS
   */

  mps_boolean DOLOG;

  mps_boolean DOWARN;

  mps_boolean DOSORT;

  FILE *instr;

  FILE *outstr;

  FILE *logstr;

  FILE *rtstr;
 
  /*
   * CONSTANT, PARAMETERS
   */

  int max_pack;

  int max_it;

  int max_newt_it;

  long int mpwp_max;

  mps_long_int_mt data_prec_max;

  pthread_mutex_t precision_mutex;

  mps_boolean just_raised_precision;

  mps_boolean random_seed;
 
  /*
   * POLYNOMIAL DATA: SHARED VARIABLES
   */

  int n;

  int deg;
 
  /* Solution related variables */

  mps_phase lastphase;

  mps_phase starting_case;

  mps_boolean best_approx;

  double last_sigma;

  int count[3];

  int zero_roots;

  int *order;

  mps_approximation ** root;

  mps_boolean skip_float;

  rdpe_t eps_in;

  rdpe_t eps_out;

  double lmax_coeff;

  long int mpwp;

  rdpe_t mp_epsilon;

  double sep;

  mps_clusterization * clusterization;

  cplx_t *fppc1;

  cdpe_t *dpc1;

  cdpe_t *dpc2;

  mpc_t *mfpc1;

  mpc_t *mfppc1;

  mps_boolean *spar1;

  int *oldpunt;

  double *fap1;

  double *fap2;

  rdpe_t *dap1;

  mps_boolean *again_old;
 
  /* SECTION -- Algorihtm selection */

  mps_algorithm algorithm;

  mps_starting_strategy starting_strategy;

  void (*mpsolve_ptr)(mps_context *status);

  mps_polynomial * active_poly;

  mps_secular_equation * secular_equation;

  int n_threads;

  mps_thread_pool * pool;

  mpc_t * bmpc;

  mps_boolean jacobi_iterations;

  const char * gnuplot_format;
 
  /* DEBUG SECTIONS */
 
  unsigned long int regeneration_time;
  unsigned long int mp_iteration_time;
  unsigned long int dpe_iteration_time;
  unsigned long int fp_iteration_time;
 
  mps_boolean exit_required;
 
  long int minimum_gmp_precision;

  mps_boolean avoid_multiprecision;

  mps_boolean crude_approximation_mode;

  mps_regeneration_driver *regeneration_driver;
 
};                   /* End of typedef struct { ... */
 
#endif /* #ifdef _MPS_PRIVATE */
 
/* Allocator, deallocator, constructors.. */
mps_context * mps_context_new (void);
void mps_context_free (mps_context * s);
 
/* Accessor functions (setters) */
void mps_context_abort (mps_context * s);
int mps_context_set_poly_d (mps_context * s, cplx_t * coeff,
                            long unsigned int n);
void mps_context_set_input_poly (mps_context * s, mps_polynomial * p);
int mps_context_set_poly_i (mps_context * s, int *coeff, long unsigned int n);
void mps_context_select_algorithm (mps_context * s, mps_algorithm algorithm);
void mps_context_set_degree (mps_context * s, int n);
 
#ifdef _MPS_PRIVATE
void mps_context_allocate_poly_inplace (mps_context * s, int n);
#endif
 
/* Accessor functions */
long int mps_context_get_data_prec_max (mps_context * s);
long int mps_context_get_minimum_precision (mps_context * s);
int mps_context_get_degree (mps_context * s);
int mps_context_get_roots_d (mps_context * s, cplx_t ** roots, double **radius);
int mps_context_get_roots_m (mps_context * s, mpc_t ** roots, rdpe_t ** radius);
int mps_context_get_zero_roots (mps_context * s);
mps_root_status mps_context_get_root_status (mps_context * ctx, int i);
mps_boolean mps_context_get_over_max (mps_context * s);
mps_polynomial * mps_context_get_active_poly (mps_context * ctx);
mps_approximation** mps_context_get_approximations (mps_context * ctx);
 
/* I/O options and flags */
void mps_context_set_input_prec (mps_context * s, long int prec);
void mps_context_set_output_prec (mps_context * s, long int prec);
void mps_context_set_output_format (mps_context * s, mps_output_format format);
void mps_context_set_output_goal (mps_context * s, mps_output_goal goal);
void mps_context_set_search_set (mps_context * s, mps_search_set set);
void mps_context_set_starting_phase (mps_context * s, mps_phase phase);
void mps_context_set_log_stream (mps_context * s, FILE * logstr);
void mps_context_set_root_stream (mps_context * s, FILE * rtstr);
void mps_context_set_jacobi_iterations (mps_context * s, mps_boolean jacobi_iterations);
void mps_context_select_starting_strategy (mps_context * s, mps_starting_strategy strategy);
void mps_context_set_avoid_multiprecision (mps_context * s, mps_boolean avoid_multiprecision);
void mps_context_set_crude_approximation_mode (mps_context * s, mps_boolean crude_approximation_mode);
void mps_context_set_regeneration_driver (mps_context * s, mps_regeneration_driver * rd);
void mps_context_set_n_threads (mps_context * s, int n_threads);
void mps_context_set_root_properties (mps_context * s, char root_properties);
 
/* Debugging */
void mps_context_set_debug_level (mps_context * s, mps_debug_level level);
void mps_context_add_debug_domain (mps_context * s, mps_debug_level level);
 
/* Get input and output config pointers */
mps_input_configuration * mps_context_get_input_config (mps_context * s);
mps_output_configuration * mps_context_get_output_config (mps_context * s);
 
/* Error handling */
mps_boolean mps_context_has_errors (mps_context * s);
char * mps_context_error_msg (mps_context * s);
 
 
#ifdef __cplusplus
}
#endif
 
#endif