intutil.c File Reference

Working with integer values. More...

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

Go to the source code of this file.

Functions
int	atoiCheck (const char *s, int *v)
unsigned int	factorial (unsigned int n)
unsigned long long int	lfactorial (unsigned long long int n)
uint32_t	sqrt_uint64 (uint64_t n)
void	intlistInit (INTLIST *l)
void	intlistFree (INTLIST *l)
int	intlistAdd (INTLIST *l, const int v, const int ifnew)
void	intlistSort (INTLIST *l)
int	intlistAddFromString (const char *s1, const char *s2, INTLIST *l, const int ifnew)
int	intlistExpandFromString (const char *s1, const char *s2, INTLIST *l, const int ifnew)

Detailed Description

Working with integer values.

Author

Vesa Oikonen

Definition in file intutil.c.

Function Documentation

atoiCheck()

int atoiCheck	(	const char *	s,
		int *	v )

Verifies that argument string at least seems like a valid integer. '\0' must follow the integer part in the string. Optional result integer value is set to 0 if string was not valid value.

See also

atofCheck, intlistAddFromString, strIsValidNumber

Returns

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

Parameters

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

Definition at line 25 of file intutil.c.

  {
  if(v!=NULL) *v=0; 
  if(s==NULL || strnlen(s, 2)<1) return(1);
  errno=0; char *tail;
  *v=strtol(s, &tail, 10);
  if(errno) {*v=0; return(2);}
  if(*tail) {*v=0; return(3);}
  return 0;
}

Referenced by intlistAddFromString(), and tacReadQView().

factorial()

unsigned int factorial

(

unsigned int

n

)

Calculate factorial of given number.

See also

lfactorial, igam, igamc

Returns

Returns factorial n!, or zero if factorial would cause wrap-around.

Parameters

n	Integer n, from which the factorial is calculated.

Note

Wrap-around will occur if n>12.

Definition at line 46 of file intutil.c.

  {
  if(n<1) return(1);
  if(n>12) return(0);
  return(n*factorial(n-1));
}

Referenced by factorial().

intlistAdd()

int intlistAdd	(	INTLIST *	l,
		const int	v,
		const int	ifnew )

Add one integer to the integer array in INTLIST structure.

See also

intlistInit, intlistFree, intlistSort, intlistAddFromString, strncatInt

Author

Vesa Oikonen

Returns

Returns the nr of added integers (either 0 or 1), or <0 in case of an error.

Parameters

l	Pointer to initiated or filled INTLIST structure.
v	Integer value to add.
ifnew	Add integer to the list only if it is new (0=no, 1=yes).

Definition at line 130 of file intutil.c.

  {
  if(l==NULL) return(-1);
  /* If only new value is to be added, then check that this is new */
  if(ifnew!=0) {for(int i=0; i<l->nr; i++) if(l->i[i]==v) return(0);}
  /* Add value to list if there is space left, and quit */
  if(l->_nr>l->nr) {l->i[l->nr++]=v; return(1);}
  /* Allocate more space */
  if(l->_nr==0) l->i=(int*)malloc(10*sizeof(int));
  else l->i=(int*)realloc(l->i, (10+l->_nr)*sizeof(int));
  if(l->i==NULL) {l->nr=l->_nr=0; return(-2);}
  l->_nr+=10;
  /* Add value to list */
  l->i[l->nr++]=v;
  return(1);
}

Referenced by intlistAddFromString(), and intlistExpandFromString().

intlistAddFromString()

int intlistAddFromString	(	const char *	s1,
		const char *	s2,
		INTLIST *	l,
		const int	ifnew )

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

See also

strTokenNr, strTokenNCpy, intlistAdd, intlistInit, intlistFree, intlistSort, intlistExpandFromString.

Returns

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

Author

Vesa Oikonen

Parameters

s1	Pointer to string from which the integers are read, for example "2,3,6,8".
s2	String containing character delimiters, for example ", ".
l	Pointer to INTLIST structure; previous contents are preserved.
ifnew	Add integer to the list only if it is new (0=no, 1=yes).

Definition at line 178 of file intutil.c.

  {
  if(l==NULL) return(-1);
  if(s1==NULL || s2==NULL) return(0);
  
  /* Get the nr of tokens */
  int i, j, m, n, v;
  n=strTokenNr((char*)s1, s2); if(n<1) return(0);
  /* Read the values */
  char tmp[128];
  for(i=j=0; i<n; i++) {
    if(strTokenNCpy(s1, s2, 1+i, tmp, 128)<1) return(-2);
    if(atoiCheck(tmp, &v)) return(-3);
    m=intlistAdd(l, v, ifnew); if(m<0) return(-4);
    j+=m;
  }
  return(j);
}

intlistExpandFromString()

int intlistExpandFromString	(	const char *	s1,
		const char *	s2,
		INTLIST *	l,
		const int	ifnew )

Read ranges and individual integer values from given string with given delimiters.

See also

strTokenNCpy, intlistAddFromString, intlistInit, intlistFree, intlistSort, strIsValidNumber

Returns

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

Author

Vesa Oikonen

Parameters

s1	Pointer to string from which the integers are read, for example "0-8,12,32-28" or "0..8, 12, 28..34".
s2	String containing character delimiters, for example ", ".
l	Pointer to INTLIST struct; previous contents are preserved.
ifnew	Add integer to the list only if it is new (0=no, 1=yes).

Definition at line 212 of file intutil.c.

  {
  if(l==NULL) return(-1);
  if(s1==NULL || s2==NULL) return(0);
  
  /* Get the nr of tokens */
  int n=strTokenNr((char*)s1, s2); if(n<1) return(0);
  /* Read the values */
  char tmp[128], tmp2[128], *t, *tail;
  int i, j, m, first, last, sw;
  for(i=j=0; i<n; i++) {
    if(strTokenNCpy(s1, s2, 1+i, tmp, 128)<1) return(-2);
    t=tmp; errno=0;
    first=strtol(t, &tail, 10); if(errno) return(-3);
    if(*tail) {
      strcpy(tmp2, tail); t=tmp2;
      if(*t=='-') t++;
      else if(*t=='.') {t++; if(*t=='.') t++; else return(-4);}
      else return(-5);
      if(!*t) return(-6);
      last=strtol(t, &tail, 10); if(errno) return(-7);
      if(*tail) return(-8);
    } else {
      last=first;
    }
 
    if(first>last) {sw=first; first=last; last=sw;}
    for(int v=first; v<=last; v++) {
      m=intlistAdd(l, v, ifnew); if(m<0) return(-10);
      j+=m;
    }
  }
  return(j);
}

Referenced by parSelectParameters(), and parSelectTACs().

intlistFree()

void intlistFree

(

INTLIST *

l

)

Free memory allocated for INTLIST. All data is cleared.

See also

intlistInit

Author

Vesa Oikonen

Parameters

l	Pointer to INTLIST structure

Definition at line 114 of file intutil.c.

  {
  if(l==NULL) return;
  free(l->i);
  intlistInit(l);
}

Referenced by parSelectParameters(), and parSelectTACs().

intlistInit()

void intlistInit

(

INTLIST *

l

)

Initiate the INTLIST structure before any use.

See also

intlistFree, intlistAdd, intlistSort

Author

Vesa Oikonen

Parameters

l	Pointer to INTLIST.

Definition at line 102 of file intutil.c.

  {
  if(l==NULL) return;
  l->nr=0; l->_nr=0;
  l->i=NULL;
}

Referenced by intlistFree(), parSelectParameters(), and parSelectTACs().

intlistSort()

void intlistSort

(

INTLIST *

l

)

Sort the integer array in INTLIST structure.

See also

intlistInit, intlistFree, intlistAdd

Author

Vesa Oikonen

Parameters

l	Pointer to INTLIST structure.

Definition at line 159 of file intutil.c.

  {
  if(l==NULL || l->i==NULL || l->nr<2) return;
  int i, j, v;
  for(i=0; i<l->nr; i++) for(j=i+1; j<l->nr; j++) {
    if(l->i[i]>l->i[j]) {v=l->i[i]; l->i[i]=l->i[j]; l->i[j]=v;}
  }
}

Referenced by parSelectParameters(), and parSelectTACs().

lfactorial()

unsigned long long int lfactorial

(

unsigned long long int

n

)

Calculate factorial of given number.

See also

factorial, igam, igamc

Returns

Returns factorial n!, or zero if factorial would cause wrap-around.

Parameters

n	Integer n, from which the factorial is calculated.

Note

Wrap-around will occur if n>20.

Definition at line 63 of file intutil.c.

  {
  if(n<1) return(1);
  if(n>20) return(0);
  return(n*lfactorial(n-1));
}

Referenced by lfactorial(), mfEvalInt(), and mfEvalY().

sqrt_uint64()

uint32_t sqrt_uint64

(

uint64_t

n

)

Calculate integer square root of a positive integer.

Returns

Returns the square root, round down to an integer.

Definition at line 79 of file intutil.c.

  {
  uint32_t r=0, a=1;
  a <<= 31;
  uint32_t temp;
  uint64_t quad;
  while(a>0) {
    quad = temp = r+a;
    quad *= temp;
    if(n>=quad) r=temp;
    a >>= 1;
  }
  return(r);
}