parameters.c

Go to the documentation of this file.

#include "parameters.h"

#include "error.h"
#include "filename.h"
#include "boolean.h"
#include "defines.h"

#include <stdlib.h>

boolean ReadParameters(char *file,Tparameters *p);

/*
 * Inits a parameter structure and defines all parameters equal to 0
 */
void InitParameters(Tparameters *p)
{
  unsigned int i;

  for(i=0;i<NPARAMETERS;i++)
    {
      (*p)[i].name=NULL;
      (*p)[i].value=0.0;
    }
}

/*
 * Inits a parameter structure from the given file
 */
void InitParametersFromFile(char *file,Tparameters *p)
{
  Tfilename dp;

  InitParameters(p);
 
  /* The existence of a default parameter file in directory
     share is optional */
  CreateFileName(_CUIK_SUITE_MAIN_DIR,DEFAULT_PARAMS,NULL,PARAM_EXT,&dp);
  ReadParameters(GetFileFullName(&dp),p);
  DeleteFileName(&dp);

  /* The existence of the parameter file associated with the
     problem is compulsatory */
  if (!ReadParameters(file,p))
    {
      char ErrorText[500];

      sprintf(ErrorText,"File %s does not exists",file);
      Error(ErrorText);
    }
}

/*
 * Returns the value of parameter number 'n'
 */
double GetParameter(unsigned int n,Tparameters *p)
{
  if (n<NPARAMETERS)
    {
      if ((*p)[n].name==NULL)
         Error("Undefined parameter");
      else
        return((*p)[n].value);
    }
  else
    Error("Number of parameter out of range");
  return(0.0);
}

/*
 * Sets a new parameter with identifier 'n', with name 'name', and with value 'v'
 */
void SetParameter(unsigned int n,char *name,double v,Tparameters *p)
{
  if (n<NPARAMETERS)
    {
      if ((*p)[n].name!=NULL)
        ChangeParameter(n,v,p);
      else
        {
          (*p)[n].name=name;
          (*p)[n].value=v;
        }
    }
  else
    Error("Number of parameter out of range");
}

/*
 * Changes the value of parameter 'n'
 */
void ChangeParameter(unsigned int n,double v,Tparameters *p)
{
  if (n<NPARAMETERS)
    {
      if ((*p)[n].name==NULL)
        {
          /*we are adding new paremeter but without a explicit name*/
          NEW((*p)[n].name,10,char);
          sprintf((*p)[n].name,"p%u",n);
        }
      
      (*p)[n].value=v;
    }
  else
    Error("Number of parameter out of range");
}

/*
 * Prints a set of parameters.
 * Only those explicitly used are shown.
 */
void PrintParameters(FILE *f,Tparameters *p)
{
  unsigned int i;

  fprintf(f,"%%COMPILATION FLAGS:\n");
  fprintf(f,"%%   SIMPLEX ENGINE: %s\n",(_SIMPLEX_ENGINE==_GLPK?"glpk":(_SIMPLEX_ENGINE==_CLP?"clp":"lp_solve")));
  fprintf(f,"%%   MPI: %u\n",_USE_MPI);
  fprintf(f,"%%   DEBUG: %u\n",_DEBUG);
  fprintf(f,"%%   PROFILE: %u\n",_PROFILE);
  fprintf(f,"%%==========================================================================\n");
  fprintf(f,"%%PARAMETERS:\n");
  for(i=0;i<NPARAMETERS;i++)
    {
      if ((*p)[i].name!=NULL)
        fprintf(f,"   %s= %g\n",(*p)[i].name,(*p)[i].value); /*all parameters are definied (if not an error is
                                                               issued after parameter initialization)*/
    }
}

void DeleteParameters(Tparameters *p)
{
}