Format.h File Reference

#include "ObjectStructure.h"
#include "StringMatrix.h"

Include dependency graph for Format.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
int C2F()	graduate (double *xmi, double *xma, double *xi, double *xa, integer *np1, integer *np2, integer *kminr, integer *kmaxr, integer *ar)
int	ComputeC_format (sciPointObj *pobj, char *c_format)
int	ComputeXIntervals (sciPointObj *pobj, char xy_type, double **vector, int *N, int checkdim)
StringMatrix *	computeDefaultTicsLabels (sciPointObj *pobj)
int	ChooseGoodFormat (char *c_format, char logflag, double *_grads, int n_grads)
void	ChoixFormatE1 (char *fmt, double *xx, integer nx)
void	ChoixFormatE (char *fmt, double xmin, double xmax, double xpas)
double *	ReBuildTicksLog2Lin (char logflag, int nbtics, double *grads)
void	correctBounds (double min, double max, double *lBound, double *uBound)
char *	copyFormatedValue (double value, const char format[5], int bufferSize)
char **	copyFormatedArray (const double values[], int nbStrings, const char format[5], int bufferSize)
int	TheTicks (double *xminv, double *xmaxv, double *grads, int *ngrads, int compNgrads)
int	GradLog (double _min, double _max, double *_grads, int *n_grads, int compNgrads)
int	GradEqual (const double grads[], const int *ngrads)
char *	getFPF (void)
int	sciGetLogExponent (double minBound, double maxBound, double *expMin, double *expMax)

---

Function Documentation

void ChoixFormatE	(	char *	fmt,
		double	xmin,
		double	xmax,
		double	xpas
	)

ChoixFormatE returns a format ("%.*f" or "%.*e") in fmt given xmin,xmax,pas. fmt : character string fmt gives a format which can be used to display number in range xmin:step:xmax Exemple : ChoixFormatE(format,min,max,step); fprintf(format,min+k*step); The format is searched so as to give distinct values for the numeric values xmin + k*xpas in [xmin,xmax] and give enough precision.

Definition at line 80 of file Format.c.

References c, FormatPrec(), and Fsepare().

Referenced by ChooseGoodFormat(), ComputeC_format(), sciGraphics::AutomaticTicksComputer::getTicksPosition(), and sciGraphics::AutoLogTicksComputer::getTicksPosition().

{
  char c;
  integer des,len = 0;
  /* format f minimal  */
  for ( des = 0 ; des < 5 ; des++)
    {
      if (Fsepare("%.*f",des,&len,xmin,xmax,xpas)) break;
    }
  if ( des < 5 && len <= 6)
    {
      c='f';
      strcpy(fmt,"%.*f");
    }
  else 
    {
      for ( des = 0 ; des < 5 ; des++)
        {
          if (Fsepare("%.*e",des,&len,xmin,xmax,xpas)) break;
        }
      c='e';
      strcpy(fmt,"%.*e");
    }
  FormatPrec(fmt,&des,xmin,xmax,xpas);
  sprintf(fmt,"%%.%d%c",des,c);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void ChoixFormatE1	(	char *	fmt,
		double *	xx,
		integer	nx
	)

same as ChoixFormatE when numbers are given through an array xx[0:nx-1];

Definition at line 156 of file Format.c.

References c, FormatPrec1(), and Fsepare1().

Referenced by ComputeC_format(), and contourI().

{
  char c;
  integer des,len = 0;
  /* format f minimal  */
  for ( des = 0 ; des < 5 ; des++)
    {
      if (Fsepare1("%.*f",des,&len,xx,nx)) break;
    }
  if ( des < 5 && len <= 6)
    {
      c='f';
      strcpy(fmt,"%.*f");
    }
  else 
    {
      for ( des = 0 ; des < 5 ; des++)
        {
          if (Fsepare1("%.*e",des,&len,xx,nx)) break;
        }
      c='e';
      strcpy(fmt,"%.*e");
    }
  FormatPrec1(fmt,&des,xx,nx);
  sprintf(fmt,"%%.%d%c",des,c);
}

Here is the call graph for this function:

Here is the caller graph for this function:

int ChooseGoodFormat	(	char *	c_format,
		char	logflag,
		double *	_grads,
		int	n_grads
	)

add comment

Parameters:

	c_format
	logflag
	_grads
	n_grads

Returns:

<ReturnValue>

Definition at line 1380 of file Format.c.

Referenced by AllocAndSetUserLabels().

{
  int last_index = n_grads - 1;

  if(logflag == 'l')
  {
    ChoixFormatE(c_format,
      exp10(_grads[0]),
      exp10(_grads[last_index]),
      (( exp10(_grads[last_index]))-( exp10(_grads[0])))/(last_index));
  }
  else
  {
    ChoixFormatE(c_format,
      _grads[0],
      _grads[last_index],
      ((_grads[last_index])-(_grads[0]))/(last_index)); /* Adding F.Leray 06.05.04 */
  }

  return 0;

}

Here is the caller graph for this function:

int ComputeC_format	(	sciPointObj *	pobj,
		char *	c_format
	)

add comment

Parameters:

	pobj
	c_format

Returns:

<ReturnValue>

Real to Pixel values

Horizontal axes

compute a format

the horizontal segment

Vertical axes

the vertical segment

Definition at line 1052 of file Format.c.

References _, ChoixFormatE(), ChoixFormatE1(), FREE, i, j, MALLOC, NULL, pAXES_FEATURE, pos, pSUBWIN_FEATURE, SCI_AXES, sciGetCurrentSubWin(), sciGetEntityType(), sciprint(), x, and y.

Referenced by computeDefaultTicsLabels(), sciGraphics::AxesTicksComputer::getTicksPosition(), set_xtics_coord_property(), and set_ytics_coord_property().

{
  int i,j;
  char pos;
  char xy_type;
  double *x = NULL;
  double *y = NULL;
  int *nx = NULL;
  int *ny = NULL;
  char * format = NULL;
  sciPointObj * psubwin = sciGetCurrentSubWin();
  int  xpassed = 0, ypassed = 0, Nx = 0, Ny = 0, x3, y3;


  if(sciGetEntityType(pobj) != SCI_AXES){
    sciprint(_("Error: ComputeFormat must be used with SCI_AXES objects\n"));
    return -1;
  }

  pos = pAXES_FEATURE(pobj)->dir;
  xy_type = pAXES_FEATURE (pobj)->tics;
  /* Allocating space before re-copying values to not polluate the good values 
  that will be used inside Axes.c */
  if((x=MALLOC((pAXES_FEATURE (pobj)->nx)*sizeof(double)))==NULL){
          sciprint(_("%s: No more memory.\n"),"ComputeC_format");
          return -1;
  }

  if((y=MALLOC((pAXES_FEATURE (pobj)->ny)*sizeof(double)))==NULL){
          sciprint(_("%s: No more memory.\n"),"ComputeC_format");
          return -1;
  }

  if((nx=MALLOC(sizeof(int)))==NULL){
          sciprint(_("%s: No more memory.\n"),"ComputeC_format");
          return -1;
  }  

  if((ny=MALLOC(sizeof(int)))==NULL){
          sciprint(_("%s: No more memory.\n"),"ComputeC_format");
          return -1;
  } 

  if((format=MALLOC(5*(sizeof(char ))+1))==NULL){
          sciprint(_("%s: No more memory.\n"),"ComputeC_format");
          return -1;
  } 

  nx[0] = pAXES_FEATURE (pobj)->nx;
  for(i=0;i<(*nx);i++)  x[i] = pAXES_FEATURE(pobj)->vx[i];  

  ny[0] = pAXES_FEATURE (pobj)->ny;
  for(i=0;i<(*ny);i++)  y[i] = pAXES_FEATURE(pobj)->vy[i];

  format = pAXES_FEATURE (pobj)->format;

  /* Algo. here */
  if(xy_type == 'i') {  
    switch ( pos ) {
    case 'u' : case 'd' :  
      if(pSUBWIN_FEATURE(psubwin)->logflags[0] == 'n')
        while (x[3]>10)  x[3]=floor(x[3]/2); 
      else{
        if(x[3] > 12){ /* F.Leray arbitrary value=12 for the moment */
          x3=(int)x[3];     /* if x[3]>12 algo is triggered to search a divisor */
          for(j=x3-1;j>1;j--)
            if(x3%j == 0){
              x[3]=j; 
              xpassed = 1;
            }
            if(xpassed != 1) x[3] = 1;
        }
      }

      break;
    case 'r' : case 'l' :
      if(pSUBWIN_FEATURE(psubwin)->logflags[1] == 'n')
        while (y[3]>10)  y[3]=floor(y[3]/2);
      else{
        if(y[3] > 12){
          y3=(int)y[3];
          for(j=y3-1;j>1;j--)
            if(y3%j == 0){
              y[3]=j;
              ypassed = 1;
            }
            if(ypassed != 1) y[3] = 1;
        }
      }
    }
  }


  switch ( xy_type ) 
  {
  case 'v' : Nx= *nx; Ny= *ny; break;
  case 'r' :
    switch ( pos ) {
  case 'u' : case 'd' : Nx = (int) x[2]+1; break;
  case 'r' : case 'l' : Ny = (int) y[2]+1; break;
    }
    break;
  case 'i' : 
    switch ( pos ) {
  case 'u' : case 'd' : Nx = (int) x[3]+1; break; 
  case 'r' : case 'l' : Ny = (int) y[3]+1; break;
    }
    break;
  default: 
    sciprint(_("%s: Wrong type argument %s.\n"),"Sci_Axis","xy_type");
  }
  switch (pos ) 
  {
  case 'u' : 
  case 'd' :
    /*   barlength =  (integer) (Cscale.WIRect1[3]/50.0); */
    /*   if (str == NULL && format == NULL )   */
    if (format == NULL )  
      switch (xy_type ) {
  case 'v' : ChoixFormatE1(c_format,x,Nx);break;
  case 'r' : ChoixFormatE (c_format,x[0],x[1],(x[1]-x[0])/x[2]);break;
  case 'i' : 
    ChoixFormatE (c_format,
      (x[0] * exp10(x[2])),
      (x[1] * exp10(x[2])),
      ((x[1] * exp10(x[2])) - (x[0] * exp10(x[2])))/x[3]); break; /* Adding F.Leray 06.05.04 */

    }
    break;
  case 'r' : 
  case 'l' :

    /*   barlength =  (integer) (Cscale.WIRect1[2]/75.0); */
    /*   if (str == NULL &&  format == NULL )   */
    if (format == NULL ) 
      switch (xy_type ) {
  case 'v' : ChoixFormatE1(c_format,y,Ny);break;
  case 'r' : ChoixFormatE(c_format,y[0],y[1],(y[1]-y[0])/y[2]);break;
  case 'i' : 
    ChoixFormatE (c_format,
      (y[0] * exp10(y[2])),
      (y[1] * exp10(y[2])),
      ((y[1] * exp10(y[2])) - (y[0] * exp10(y[2])))/y[3]); break; /* Adding F.Leray 06.05.04 */
    }
    break;
  }

  /* c_format should be filled now */

  FREE(x); x = NULL;
  FREE(y); y = NULL;
  FREE(nx); nx = NULL;
  FREE(ny); ny = NULL;
  FREE(format); format = NULL;

  return 0;

}

Here is the call graph for this function:

Here is the caller graph for this function:

StringMatrix* computeDefaultTicsLabels

(

sciPointObj *

pobj

)

add comment

Parameters:

pobj

Returns:

<ReturnValue>

Compute the default labels of an axis from the positions of the ticks.

Parameters:

in/out]

pobj the axis object

Returns:

a string matrix containing the labels. Actually it is a row vector.

Definition at line 1321 of file Format.c.

References _, ComputeC_format(), ComputeXIntervals(), copyStrMatElement(), FREE, i, newMatrix(), NULL, pAXES_FEATURE, Scierror(), and sciprint().

Referenced by get_tics_labels_property().

{
  StringMatrix * ticsLabels = NULL   ;
  int            nbTics     = 0      ;
  char           c_format[5]         ;
  double       * vector     = NULL   ; /* position of labels */
  char           curLabelBuffer[257] ;
  int            i                   ;

  if ( pAXES_FEATURE(pobj)->format == NULL )
  {
    /* we need to compute c_format */
    ComputeC_format( pobj, c_format ) ;
  }
  else
  {
    int i2 ;
    for ( i2 = 0 ; i2 < 5 ; i2++ )
    {
      c_format[i2] = pAXES_FEATURE(pobj)->format[i2] ;
    }
  }

  /* vector is allocated here */
  if( ComputeXIntervals( pobj, pAXES_FEATURE (pobj)->tics, &vector, &nbTics, 1 ) != 0 )
  {
    Scierror(999,_("Error: Bad size in %s: you must first increase the size of the %s.\n"),"tics_coord","tics_coord");
    return 0;
  }

  ComputeC_format( pobj, c_format ) ;

  /* create a vector of strings */
  ticsLabels = newMatrix( 1, nbTics ) ;

  if ( curLabelBuffer == NULL )
  {
          sciprint(_("%s: No more memory.\n"),"computeDefaultTicsLabels");
          return NULL ;
  }

  for( i = 0 ; i < nbTics ; i++ )
  {
    sprintf(curLabelBuffer,c_format,vector[i]) ; /* we can't know for sure the size of the label */
                                                 /* That's why it is first stored in a big array */
    copyStrMatElement( ticsLabels, 0, i, curLabelBuffer ) ;
  }
  FREE(vector) ;
  vector = NULL;

  /* I recompute the nb_tics_labels */
  /* Why ??? jb Silvy */
  pAXES_FEATURE (pobj)->nb_tics_labels = nbTics;

  return ticsLabels ;

}

Here is the call graph for this function:

Here is the caller graph for this function:

int ComputeXIntervals	(	sciPointObj *	pobj,
		char	xy_type,
		double **	vector,
		int *	N,
		int	checkdim
	)

add comment

Parameters:

	pobj
	xy_type
	vector
	N
	checkdim

Returns:

<ReturnValue>

Definition at line 1217 of file Format.c.

References _, FALSE, i, MALLOC, n, NULL, sciAxes::nx, sciAxes::ny, pAXES_FEATURE, sciprint(), TRUE, val, sciAxes::vx, and sciAxes::vy.

Referenced by computeDefaultTicsLabels(), sciGraphics::AxesPositioner::getAxisBounds(), sciGraphics::AxesTicksComputer::getNbTicks(), sciGraphics::AxesTicksComputer::getTicksPosition(), set_tics_style_property(), set_xtics_coord_property(), and set_ytics_coord_property().

{
  int i;
  sciAxes * ppaxes = pAXES_FEATURE (pobj);
  double * val = NULL; /* reprensents ppaxes->x or ppaxes->y */
  int nval;

  int n;

  /* draw an horizontal axis : YES (horizontal axis) or NO (vertical axis) */
  BOOL ishoriz = (ppaxes->nx > ppaxes->ny)? TRUE : FALSE; 

  if(ishoriz == TRUE){
    val  = ppaxes->vx;
    nval = ppaxes->nx; 
  }
  else{
    val  = ppaxes->vy;
    nval = ppaxes->ny;
  }

  if(xy_type == 'v')
  {
    *N = n = nval;

    if((*vector = (double *) MALLOC(n*sizeof(double ))) == NULL){
          sciprint(_("%s: No more memory.\n"),"ComputeXIntervals");
      return -1;
    }

    for(i=0;i<n;i++)
      (*vector)[i] = val[i];
  }
  else if(xy_type == 'r')
  {
    double step = 0;

    *N = n = (int)val[2]+1; /* intervals number is given by  ppaxes->x or ppaxes->y */

    if(checkdim){
      if(nval != 3)
        sciprint(_("Warning: %s must be changed, %s is '%s' and %s dimension is not %d.\n"),"tics_coord","xy_type","r","tics_coord",3);

      if(nval < 3){
        sciprint(_("Error: %s must be changed FIRST, %s is '%s' and %s dimension < %d.\n"),"tics_coord","xy_type","r","tics_coord",3);
        *vector = (double *) NULL;
        return -1;
      }
    }

    if((*vector = (double *) MALLOC(n*sizeof(double ))) == NULL){
          sciprint(_("%s: No more memory.\n"),"ComputeXIntervals");
      return -1;
    }

    step = (val[1] - val[0])/(n-1);

    for(i=0;i<n-1;i++)
      (*vector)[i] = val[0] + i*step;

    (*vector)[n-1] = val[1]; /* xmax */

  }
  else if(xy_type == 'i')
  {
    double step = 0;

    *N = n = (int)val[3]+1;

    if(checkdim){
      if(nval != 4)
        sciprint(_("Warning: %s must be changed, %s is '%S' and %s dimension is not %d.\n"),"tics_coord","xy_type","i","tics_coord",4);

      if(nval < 4){
        sciprint(_("Error: %s must be changed FIRST, %s is '%s' and %s dimension < %d.\n"),"tics_coord","xy_type","i","tics_coord",4);
        *vector = (double *) NULL;
        return -1;
      }
    }

    if((*vector =(double *)  MALLOC(n*sizeof(double ))) == NULL){
          sciprint(_("%s: No more memory.\n"),"ComputeXIntervals");
      return -1;
    }

    step = (val[1]*exp10(val[2]) - val[0]*exp10(val[2]))/val[3];


    for(i=0;i<n-1;i++)
      (*vector)[i] = val[0]*exp10(val[2]) + i*step;

    (*vector)[n-1] = val[1]*exp10(val[2]); /* xmax */

  }

  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

char** copyFormatedArray	(	const double	values[],
		int	nbStrings,
		const char	format[5],
		int	bufferSize
	)

Create a new string array which is the conversion of the doubles values.

Parameters:

bufferSize

size of the buffer used to store the store before the copying it to the result. It must greater than the length of any of the strings. and ideally the maximum length.

Definition at line 1479 of file Format.c.

References _, copyFormatedValue(), i, MALLOC, NULL, res, and sciprint().

Referenced by sciGraphics::AxesTicksComputer::getTicksPosition(), set_xtics_coord_property(), and set_ytics_coord_property().

{
  int i ;
  char ** res = MALLOC( nbStrings * sizeof(char *) ) ;

  if ( res == NULL )
  {
          sciprint(_("%s: No more memory.\n"),"copyFormatedArray");
          return NULL ;
  }

  for ( i = 0 ; i < nbStrings ; i++ )
  {
    res[i] = copyFormatedValue( values[i], format, bufferSize ) ;
  }

  return res ;

}

Here is the call graph for this function:

Here is the caller graph for this function:

char* copyFormatedValue	(	double	value,
		const char	format[5],
		int	bufferSize
	)

Create a new string which is the result the conversion of a double value using a certain format

Parameters:

bufferSize

size of the buffer used to store the store before the copying it to the result. It must greater than the length of the returning string. and ideally the same length.

Returns:

the newly created strings, or NULL if an error occurred.

Definition at line 1447 of file Format.c.

References _, buffer, FREE, MALLOC, NULL, res, and sciprint().

Referenced by copyFormatedArray().

{
  char * buffer = MALLOC( bufferSize * sizeof(char) ) ;
  char * res = NULL ;
  int resLength = 0 ;

  if ( buffer == NULL )
  {
          sciprint(_("%s: No more memory.\n"),"copyFormatedValue");
          return NULL ;
  }

  sprintf( buffer , format, value ) ;

  resLength =  (int)strlen( buffer ) + 1 ; /* + 1 <=> 0 terminating char */

  res = MALLOC( resLength * sizeof(char) ) ;

  if ( res == NULL )
  {
          sciprint(_("%s: No more memory.\n"),"copyFormatedValue");
          FREE( buffer ) ;
          return NULL ;
  }

  strncpy( res, buffer, resLength ) ;

  FREE( buffer ) ;
  
  return res ;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void correctBounds	(	double	min,
		double	max,
		double *	lBound,
		double *	uBound
	)

add comment

Parameters:

	min
	max
	lBound
	uBound

compute new bounds when the given ones are to close for display.

Parameters:

[in]	min	Given minimal bound.
[in]	max	Given maximal bound.
[out]	lBound	New lower bound which can be displayed.
[out]	uBound	New upper bound which can be displayed.

Definition at line 714 of file Format.c.

References Abs, and Max.

{
  double offset ;

  if ( Abs(min) < 10.0 && Abs(max) < 10.0 )
  {
    /* we can use 1 */
    offset = 1.0 ;
  }
  else
  {
    /* get the power 10 just below |min| and |max| */
    /* we could use 1 also but for huge values this does not work (if val + 1 == val) */
    offset = pow( 10.0, floor( log10( Max( Abs(min), Abs(max) ) ) ) ) ;
  }

  /* first try to just get the closest integer */
  *lBound = floor( min ) ;
  *uBound = ceil(  max ) ;
  

  /* check if it is enough */
  if (  min - *lBound < 0.2 )
  {
    *lBound = *lBound - offset ;
  }
  if ( *uBound - max < 0.2 )
  {
    *uBound = *uBound + offset ;
  }
}

char* getFPF

(

void

)

add comment

Parameters:

void

Returns:

<ReturnValue>

Definition at line 1506 of file Format.c.

Referenced by contourI().

{
  return(FPF);
}

Here is the caller graph for this function: