decpoint.c File Reference

Decimal point functions. More...

#include "tpcclibConfig.h"
#include <stdio.h>
#include <stdlib.h>
#include <time.h>
#include <string.h>
#include <ctype.h>
#include <unistd.h>
#include <math.h>
#include "tpcextensions.h"

Go to the source code of this file.

Functions
int	strIsValidNumber (const char *s)
double	atofVerified (const char *s)
int	atofCheck (const char *s, double *v)
int	strHaveDecimalComma (const char *s)
int	strHaveDecimalSeparator (const char *s)
int	atofList (const char *s1, const char *s2, double *x, int maxn)

Detailed Description

Decimal point functions.

Decimal point in data files and user-specified arguments can be either dot (UK/USA) or comma (EU), independent on what is the defined locale on the current platform. Therefore we usually need to try to correctly read decimal numbers whether they are stored in either format, and to convert decimal dots to commas and vice versa. This file contains functions used for that purpose.

Author

Vesa Oikonen

Definition in file decpoint.c.

Function Documentation

atofCheck()

int atofCheck	(	const char *	s,
		double *	v )

Verifies that argument string at least seems like a valid number.

Both decimal point and comma are accepted. Optional result double value is set to NaN if string was not valid value.

See also

atofVerified, atoiCheck, doubleGetWithUnit, atofList, strCleanSpaces, strIsValidNumber

Returns

0 if successful, and 1 in case of an error.

Parameters

s	String which is converted to a double; string must not contain any space characters.
v	Pointer to the double float; enter NULL, if not needed.

Definition at line 94 of file decpoint.c.

  {
  if(v!=NULL) *v=nan(""); 
  if(s==NULL) return 1;
  if(!strIsValidNumber(s)) return 1;
  char *p; p=strchr(s, ','); if(p==NULL) {*v=atof(s); return 0;}
  char *s2=strdup(s); p=strchr(s2, ','); *p='.';
  *v=atof(s2); free(s2); return 0;
}

Referenced by doubleGetWithUnit(), floatGetWithUnit(), iftGetDoubleValue(), tacReadCarimasTxt(), and tacReadInveonCSV().

atofList()

int atofList	(	const char *	s1,
		const char *	s2,
		double *	x,
		int	maxn )

Read a list of double values from given string with given delimiters.

Returns

The number of double values, or <0 in case of an error.

Author

Vesa Oikonen

See also

strTokenNr, strTokenNCpy, intlistAddFromString, atofCheck, tpcYesNo, doubleCopy, doubleSpanPositives

Parameters

s1	Pointer to string from which double values are read.
s2	String containing character delimiters
x	Pointer to a pre-allocated array of doubles.
maxn	Size of double list; obligatory. If string contains more values, only maxn values will be read.

Definition at line 150 of file decpoint.c.

  {
  if(x==NULL || maxn<=0) return(-1);
  for(int i=0; i<maxn; i++) x[i]=nan("");
  if(s1==NULL || s2==NULL) return(0);
  
  /* Get the nr of tokens */
  int i, n;
  n=strTokenNr((char*)s1, s2); if(n<1) return(0);
  /* Read the values */
  char tmp[256];
  double v; 
  for(i=0; i<n && i<maxn; i++) {
    if(strTokenNCpy(s1, s2, 1+i, tmp, 256)<1) return(-2);
    v=atofVerified(tmp); if(isnan(v)) return(-3);
    x[i]=v;
  }
  return(i);
}

atofVerified()

double atofVerified

(

const char *

s

)

Version of atof() which verifies that argument string at least seems like a valid number.

Both decimal point and comma are accepted. Result value is set to NaN if string was not valid value.

See also

atofCheck, doubleGetWithUnit, atoiCheck, strIsValidNumber, tpcYesNo

Returns

converted double value, or NaN in case of an error.

Parameters

s	String which is converted to a double; string must not contain any space characters.

Definition at line 75 of file decpoint.c.

  {
  if(s==NULL || !strIsValidNumber(s)) return nan("");
  char *p; p=strchr(s, ','); if(p==NULL) return atof(s);
  char *s2=strdup(s); p=strchr(s2, ','); *p='.';
  double t=atof(s2); free(s2); return t;
}

Referenced by atofList(), dcmImgIsotope(), iftGetDoubleWithUnit(), parReadCSV(), parReadFIT(), parReadRES(), tacRead4DM(), tacReadCSV(), tacReadDFT(), tacReadHRPLUSHC(), tacReadHRRTHC(), tacReadMat(), tacReadPMOD(), tacReadQView(), tacReadSIF(), and tacReadSimple().

strHaveDecimalComma()

int strHaveDecimalComma

(

const char *

s

)

Checks whether argument string contains a decimal comma instead of dot.

Author

Vesa Oikonen

Returns

1 if decimal comma is found and 0 if not.

See also

strHaveDecimalSeparator, atofVerified, strIsValidNumber

Parameters

s	Pointer to string.

Definition at line 115 of file decpoint.c.

  {
  if(s==NULL) return(0);
  if(strchr(s, '.')!=NULL) return(0);
  if(strchr(s, ',')!=NULL) return(1);
  return(0);
}

Referenced by tacReadCSV().

strHaveDecimalSeparator()

int strHaveDecimalSeparator

(

const char *

s

)

Checks whether argument string contains a decimal comma or dot, or neither.

Author

Vesa Oikonen

Returns

0, if neither is found, 1 if dot, and 2 if comma is found.

See also

strHaveDecimalComma, atofVerified, strIsValidNumber

Parameters

s	Pointer to string.

Definition at line 132 of file decpoint.c.

  {
  if(s==NULL) return(0);
  if(strchr(s, '.')!=NULL) return(1);
  if(strchr(s, ',')!=NULL) return(2);
  return(0);
}

strIsValidNumber()

int strIsValidNumber

(

const char *

s

)

Verifies that given string seems like a valid representation of integer or floating point number in decimal or exponential format.

Returns

1 if string is valid number, and 0 if not.

Author

Vesa Oikonen

See also

atofVerified, atoiCheck, tpcYesNo

Parameters

s	Pointer to the string to be verified; it must not contain any leading or trailing space characters etc, or it will never verify.

Definition at line 33 of file decpoint.c.

  {
  if(s==NULL || strnlen(s, 256)<1) return 0;
 
  char *p=(char*)s;
  int i, nn=0;
  /* It can start with + or minus */
  if(*p=='+' || *p=='-') p++;
  /* Then jump over all digits, counting them */
  i=strspn(p, "0123456789"); nn+=i; p+=i;
  if(!*p) {if(nn>0) return 1; else return 0;} // end of string
  /* Then there can be a decimal point or comma, but only one per string */
  if(*p=='.' || *p==',') p++;
  if(!*p) {if(nn>0) return 1; else return 0;} // end of string
  /* Again jump over all digits, counting them */
  i=strspn(p, "0123456789"); nn+=i; p+=i;
  /* At this point we must have got at least one digit */
  if(nn<1) return 0;
  if(!*p) return 1; // end of string
  /* String continues, the next character must be E or e */
  if(*p=='E' || *p=='e') p++; else return 0;
  /* next can be + or - but not necessarily */
  if(*p=='+' || *p=='-') p++;
  /* then we must have at least one digit */
  i=strspn(p, "0123456789"); if(i<1) return 0;
  nn+=i; p+=i;
  /* now we must be at the end of string */
  if(!*p) return 1; else return 0; 
}

Referenced by atofCheck(), and atofVerified().