nf_utilities.h File Reference

#include <stdio.h>
#include <stdint.h>
#include <string.h>
#include <stdarg.h>
#include <math.h>
#include <statusMessageReporting.h>

Go to the source code of this file.

Macros
#define	_USE_MATH_DEFINES
#define	nf_floatToShortestString_trimZeros   ( 1 << 0 )
#define	nf_floatToShortestString_keepPeriod   ( 1 << 1 )
#define	nf_floatToShortestString_includeSign   ( 1 << 2 )

Typedefs
typedef enum nfu_status_e	nfu_status

Enumerations

enum

nfu_status_e {   nfu_Okay , nfu_Error , nfu_badSelf , nfu_mallocError ,   nfu_insufficientMemory , nfu_badIndex , nfu_XNotAscending , nfu_badIndexForX ,   nfu_XOutsideDomain , nfu_invalidInterpolation , nfu_divByZero , nfu_unsupportedInterpolationConversion ,   nfu_unsupportedInterpolation , nfu_empty , nfu_tooFewPoints , nfu_domainsNotMutual ,   nfu_badInput , nfu_badNorm , nfu_badIntegrationInput , nfu_otherInterpolation ,   nfu_flatInterpolation , nfu_failedToConverge , nfu_oddNumberOfValues , nfu_badLogValue }

Functions
int	nfu_setup (void)
double	nfu_getNAN (void)
int	nfu_isNAN (double d)
double	nfu_getInfinity (double sign)
const char *	nfu_statusMessage (nfu_status status)
void	nfu_setMemoryDebugMode (int mode)
void	nfu_printMsg (char const *fmt,...)
void	nfu_printErrorMsg (char const *fmt,...)
void *	nfu_malloc (size_t size)
void *	nfu_calloc (size_t size, size_t n)
void *	nfu_realloc (size_t size, void *old)
void *	nfu_free (void *p)
int32_t *	nfu_stringToListOfInt32s (statusMessageReporting *smr, char const *str, char sep, int64_t *numberConverted, char **endCharacter)
int	nfu_stringToInt32 (statusMessageReporting *smr, char const *str, char **endCharacter, int32_t *value)
double *	nfu_stringToListOfDoubles (statusMessageReporting *smr, char const *str, char sep, int64_t *numberConverted, char **endCharacter, int useSystem_strtod)
double	nf_strtod (char const *ptr, char **endCharacter)
char *	nf_floatToShortestString (double value, int significantDigits, int favorEFormBy, int flags)

Variables
int	nfu_SMR_libraryID

Macro Definition Documentation

_USE_MATH_DEFINES

#define _USE_MATH_DEFINES

Definition at line 13 of file nf_utilities.h.

nf_floatToShortestString_includeSign

#define nf_floatToShortestString_includeSign   ( 1 << 2 )

Definition at line 32 of file nf_utilities.h.

Referenced by nf_floatToShortestString().

nf_floatToShortestString_keepPeriod

#define nf_floatToShortestString_keepPeriod   ( 1 << 1 )

Definition at line 31 of file nf_utilities.h.

Referenced by nf_floatToShortestString().

nf_floatToShortestString_trimZeros

#define nf_floatToShortestString_trimZeros   ( 1 << 0 )

Definition at line 30 of file nf_utilities.h.

Referenced by LUPI::Misc::doubleToShortestString(), and nf_floatToShortestString().

Typedef Documentation

nfu_status

typedef enum nfu_status_e nfu_status

Enumeration Type Documentation

nfu_status_e

enum nfu_status_e

Enumerator
nfu_Okay
nfu_Error
nfu_badSelf
nfu_mallocError
nfu_insufficientMemory
nfu_badIndex
nfu_XNotAscending
nfu_badIndexForX
nfu_XOutsideDomain
nfu_invalidInterpolation
nfu_divByZero
nfu_unsupportedInterpolationConversion
nfu_unsupportedInterpolation
nfu_empty
nfu_tooFewPoints
nfu_domainsNotMutual
nfu_badInput
nfu_badNorm
nfu_badIntegrationInput
nfu_otherInterpolation
nfu_flatInterpolation
nfu_failedToConverge
nfu_oddNumberOfValues
nfu_badLogValue

Definition at line 38 of file nf_utilities.h.

                          {         
    nfu_Okay,               
    nfu_Error,               
    nfu_badSelf,            
    nfu_mallocError,            
    nfu_insufficientMemory,     
    nfu_badIndex,                   
    nfu_XNotAscending,      
    nfu_badIndexForX,           
    nfu_XOutsideDomain,             
    nfu_invalidInterpolation,       
    nfu_divByZero,              
    nfu_unsupportedInterpolationConversion, 
    nfu_unsupportedInterpolation,   
    nfu_empty,              
    nfu_tooFewPoints,           
    nfu_domainsNotMutual,                   
    nfu_badInput,                   
    nfu_badNorm,            
    nfu_badIntegrationInput,    
    nfu_otherInterpolation,
    nfu_flatInterpolation,
    nfu_failedToConverge,           
    nfu_oddNumberOfValues,  
    nfu_badLogValue 
} nfu_status;

Function Documentation

nf_floatToShortestString()

char * nf_floatToShortestString	(	double	value,
		int	significantDigits,
		int	favorEFormBy,
		int	flags )

Definition at line 176 of file nf_stringToDoubles.c.

                                                                                                   {
 
    int n1, ne, nf, digitsRightOfPeriod_f, exponent;
    char Str_e[512], Str_f[512], *Str_r = Str_e, Fmt[32], *e1, *e2;
    const char *sign = "";
 
    if( flags & nf_floatToShortestString_includeSign ) sign = "+";
 
    if( !isfinite( value ) ) {
        sprintf( Fmt, "%%%sf", sign );
        sprintf( Str_e, Fmt, value );
        return( strdup( Str_e ) );
    }
 
    significantDigits--;
    if( significantDigits < 0 ) significantDigits = 0;
    if( significantDigits > 24 ) significantDigits = 24;
 
    sprintf( Fmt, "%%%s.%de", sign, significantDigits );
    sprintf( Str_e, Fmt, value );
 
    e1 = strchr( Str_e, 'e' );
    if( significantDigits == 0 ) {
        if( *(e1 - 1) != '.' ) {
            char *e3;
 
            e2 = strchr( e1, 0 );
            e3 = e2 + 1;
            for( ; e2 != e1; e2--, e3-- ) *e3 = *e2;
            *(e1++) = '.';
        }
    }
    *e1 = 0;
    n1 = (int) strlen( Str_e ) - 1;
    if( flags & nf_floatToShortestString_trimZeros ) while( Str_e[n1] == '0' ) n1--;
    ne = flags & nf_floatToShortestString_keepPeriod;
    if( !( flags & nf_floatToShortestString_keepPeriod ) ) if( Str_e[n1] == '.' ) n1--;
    n1++;
    Str_e[n1] = 0;
 
    e1++;
    exponent = (int) strtol( e1, &e2, 10 );
    if( exponent != 0 ) {               /* If 0, the exponent was "e+00". */
        for( e1 = Str_e; *e1 != 0; e1++ ) ;
        sprintf( e1, "e%d", exponent );
 
        digitsRightOfPeriod_f = significantDigits - exponent;
        if( ( digitsRightOfPeriod_f > 25 ) || ( exponent > 50 ) ) return( strdup( Str_r ) );
        if( digitsRightOfPeriod_f < 0 ) digitsRightOfPeriod_f = 0;
 
        sprintf( Fmt, "%%%s.%df", sign, digitsRightOfPeriod_f );
        sprintf( Str_f, Fmt, value );
 
        ne = (int) strlen( Str_e );
        nf = (int) strlen( Str_f );
        if( strchr( Str_f, '.' ) != NULL ) {        /* '.' in string. */
            if( flags & nf_floatToShortestString_trimZeros ) while( Str_f[nf-1] == '0' ) nf--;
            if( Str_f[nf-1] == '.' ) {
                if( !( flags & nf_floatToShortestString_keepPeriod ) ) nf--;
            } }
        else {      /* Maybe we want a '.' else it looks like an integer, "12345." vs "12345". */
            if( flags & nf_floatToShortestString_keepPeriod ) {
                Str_f[nf] = '.';
                nf++;
            }
        }
        Str_f[nf] = 0;
 
        if( ( nf + favorEFormBy ) < ne ) Str_r = Str_f;
    }
    return( strdup( Str_r ) );
}

Referenced by LUPI::Misc::doubleToShortestString().

nf_strtod()

double nf_strtod	(	char const *	ptr,
		char **	endCharacter )

Definition at line 115 of file nf_stringToDoubles.c.

                                                         {
 
    *endCharacter = (char *) str;
    char *ptr = *endCharacter;
 
    while( isspace( *ptr ) ) ++ptr;                         /* Skip leading white space, if any. */
 
    double sign = 1.0;                                      /* Get sign, if any. */
    if( *ptr == '-' ) {
        sign = -1.0;
        ++ptr; } 
    else if( *ptr == '+' ) {
        ++ptr;
    }
 
    double value = 0.0;                                     /* Get digits before decimal point or exponent, if any. */
    for( ; valid_digit( *ptr ); ++ptr ) value = value * 10.0 + ( *ptr - '0' );
 
    if( *ptr == '.' ) {                                     /* Get digits after decimal point, if any. */
        double invPow10 = 0.1;
        ++ptr;
        while( valid_digit( *ptr ) ) {
            value += ( *ptr - '0' ) * invPow10;
            invPow10 *= 0.1;
            ++ptr;
        }
    }
 
    if( ( *ptr == 'e' ) || ( *ptr == 'E' ) ) {              /* Handle exponent, if any. */
        int negativeExponent = 0;
 
        ++ptr;                                            /* Get sign of exponent, if any. */
        if( *ptr == '-' ) {
            negativeExponent = 1;
            ++ptr; }
        else if( *ptr == '+' ) {
            ++ptr;
        }
 
        unsigned int exponent = 0;                      /* Get digits of exponent. There must be at least 1. */
        for( ; valid_digit( *ptr ); ++ptr ) exponent = exponent * 10 + ( *ptr - '0' );
        if( exponent > 308 ) {
            return( strtod( str, endCharacter ) );
        }
 
        double scale = 1.0;                             /* Calculate scaling factor. */
        if( exponent == 0 ) negativeExponent = 0;
        while( exponent >= 50 ) { scale *= 1E50; exponent -= 50; }
        while( exponent >=  8 ) { scale *= 1E8;  exponent -=  8; }
        while( exponent >   0 ) { scale *= 10.0; exponent -=  1; }
 
        if( negativeExponent ) scale = 1.0 / scale;
        value *= scale;
    }
 
    *endCharacter = ptr;
    return( sign * value );
}

nfu_calloc()

void * nfu_calloc	(	size_t	size,
		size_t	n )

Definition at line 133 of file nf_utilities.c.

                                          {
 
    void *p = calloc( size, n );
 
    if( nfu_debugging ) printf( "nfu_calloc  %12p size = %8llu, n = %8llu\n", p, (long long unsigned) size, (long long unsigned) n );
    return( p );
}

nfu_free()

void * nfu_free

(

void *

p

)

Definition at line 153 of file nf_utilities.c.

                          {
 
    if( p != NULL ) {
        if( nfu_debugging ) printf( "nfu_free    %12p\n", p );
        free( p );
    }
    return( NULL );
}

Referenced by nf_Legendre_free(), nf_Legendre_new(), and nf_Legendre_release().

nfu_getInfinity()

double nfu_getInfinity

(

double

sign

)

Definition at line 74 of file nf_utilities.c.

                                      {
 
    if( sign < 0 ) return( -INFINITY );
    return( INFINITY );
}

nfu_getNAN()

double nfu_getNAN

(

void

)

Definition at line 60 of file nf_utilities.c.

                          {
 
    return( NAN );
}

Referenced by ptwXY_div_ptwXY().

nfu_isNAN()

int nfu_isNAN

(

double

d

)

Definition at line 67 of file nf_utilities.c.

                          {
 
    return( isnan( d ) );
}

Referenced by ptwXY_div_ptwXY().

nfu_malloc()

void * nfu_malloc

(

size_t

size

)

Definition at line 123 of file nf_utilities.c.

                                {
 
    void *p = malloc( size );
 
    if( nfu_debugging ) printf( "nfu_malloc  %12p size = %8llu\n", p, (long long unsigned) size );
    return( p );
}

nfu_printErrorMsg()

void nfu_printErrorMsg	(	char const *	fmt,
			... )

Definition at line 176 of file nf_utilities.c.

                                               {
 
    va_list args;
 
    va_start( args, fmt );
    vfprintf( stderr, fmt, args );
    fprintf( stderr, "\n" );
    va_end( args );
 
    exit( EXIT_FAILURE );
}

nfu_printMsg()

void nfu_printMsg	(	char const *	fmt,
			... )

Definition at line 164 of file nf_utilities.c.

                                          {
 
    va_list args;
 
    va_start( args, fmt );
    vfprintf( stderr, fmt, args );
    fprintf( stderr, "\n" );
    va_end( args );
}

nfu_realloc()

void * nfu_realloc	(	size_t	size,
		void *	old )

Definition at line 143 of file nf_utilities.c.

                                            {
 
    void *p = realloc( old, size );
 
    if( nfu_debugging ) printf( "nfu_realloc %12p size = %8llu, old = %12p\n", p, (long long unsigned) size, old );
    return( p );
}

Referenced by nf_Legendre_reallocateCls().

nfu_setMemoryDebugMode()

void nfu_setMemoryDebugMode

(

int

mode

)

Definition at line 116 of file nf_utilities.c.

                                        {
 
    nfu_debugging = mode;
}

nfu_setup()

int nfu_setup

(

void

)

Definition at line 51 of file nf_utilities.c.

                      {
 
    nfu_SMR_libraryID = smr_registerLibrary( "numericalFunctions" );
 
    return( 0 );
}

nfu_statusMessage()

const char * nfu_statusMessage

(

nfu_status

status

)

Definition at line 82 of file nf_utilities.c.

                                                   {
 
printf( "status = %d\n", status );
    switch( status ) {
    case nfu_Okay : return( Okay_message );
    case nfu_Error : return( Error_message );
    case nfu_mallocError : return( mallocError_message );
    case nfu_insufficientMemory : return( insufficientMemory_message );
    case nfu_badIndex : return( badIndex_message );
    case nfu_XNotAscending : return( XNotAscending_message );
    case nfu_badIndexForX : return( badIndexForX_message );
    case nfu_XOutsideDomain : return( XOutsideDomain_message );
    case nfu_invalidInterpolation : return( invalidInterpolation_message );
    case nfu_badSelf : return( badSelf_message );
    case nfu_divByZero : return( divByZero_message );
    case nfu_unsupportedInterpolation : return( unsupportedInterpolation_message );
    case nfu_unsupportedInterpolationConversion : return( unsupportedInterpolationConversion_message );
    case nfu_empty : return( empty_message );
    case nfu_tooFewPoints : return( tooFewPoints_message );
    case nfu_domainsNotMutual : return( notMutualDomian_message );
    case nfu_badInput : return( badInput_message );
    case nfu_badNorm : return( badNorm_message );
    case nfu_badIntegrationInput : return( badIntegrationInput_message );
    case nfu_otherInterpolation : return( otherInterpolation_message );
    case nfu_flatInterpolation : return( flatInterpolation_message );
    case nfu_failedToConverge : return( failedToConverge_message );
    case nfu_oddNumberOfValues : return( oddNumberOfValues_message );
    case nfu_badLogValue : return( badLogValue_message );
    }
    return( unknownStatus_message );
}

nfu_stringToInt32()

int nfu_stringToInt32	(	statusMessageReporting *	smr,
		char const *	str,
		char **	endCharacter,
		int32_t *	value )

Definition at line 126 of file nf_stringToInt32s.c.

                                                                                                           {
 
    long lValue = strtol( str, endCharacter, 10 );
 
    if( lValue < INT32_MIN ) {
        smr_setReportError2( smr, nfu_SMR_libraryID, nfu_badInput, "int32_t underflow: %l", lValue );
        return( -1 ); }
    else if( lValue > INT32_MAX ) {
        smr_setReportError2( smr, nfu_SMR_libraryID, nfu_badInput, "int32_t overflow: %l", lValue );
        return( 1 );
    }
    *value = (int) lValue;
    return( 0 );
}

nfu_stringToListOfDoubles()

double * nfu_stringToListOfDoubles	(	statusMessageReporting *	smr,
		char const *	str,
		char	sep,
		int64_t *	numberConverted,
		char **	endCharacter,
		int	useSystem_strtod )

Definition at line 26 of file nf_stringToDoubles.c.

                                                    {
 
    if( strchr( "0123456789.+-eE", sep ) != NULL ) {
        smr_setReportError2( smr, nfu_SMR_libraryID, nfu_badInput, "Invalid sep ='%c'.", sep );
        return( NULL );
    }
 
    *numberConverted = 0;
    *endCharacter = (char *) str;
    if( isspace( sep ) ) sep = ' ';             /* Make it the space character if any white space as it simplifies logic below. */
    return( nfu_stringToListOfDoubles2( smr, str, sep, numberConverted, endCharacter, useSystem_strtod ) );
}

Referenced by MCGIDI::convertACE_URR_probabilityTablesFromGIDI(), ptwX_fromString(), and ptwXY_fromString().

nfu_stringToListOfInt32s()

int32_t * nfu_stringToListOfInt32s	(	statusMessageReporting *	smr,
		char const *	str,
		char	sep,
		int64_t *	numberConverted,
		char **	endCharacter )

Definition at line 27 of file nf_stringToInt32s.c.

                              {
 
    if( strchr( "0123456789.+-eE", sep ) != NULL ) {
        smr_setReportError2( smr, nfu_SMR_libraryID, nfu_badInput, "Invalid sep ='%c'.", sep );
        return( NULL );
    }
 
    *numberConverted = 0;
    *endCharacter = (char *) str;
    if( isspace( sep ) ) sep = ' ';             /* Make it the space character if any white space as it simplifies logic below. */
    return( nfu_stringToListOfInt32s_2( smr, str, sep, numberConverted, endCharacter ) );
}

Variable Documentation

nfu_SMR_libraryID

int nfu_SMR_libraryID

extern

Definition at line 46 of file nf_utilities.c.

Referenced by nf_Legendre_allocated(), nf_Legendre_clone(), nf_Legendre_evauluateAtMu(), nf_Legendre_from_ptwXY(), nf_Legendre_getCl(), nf_Legendre_initialize(), nf_Legendre_maxOrder(), nf_Legendre_normalize(), nf_Legendre_reallocateCls(), nf_Legendre_setCl(), nf_Legendre_to_ptwXY(), nfu_setup(), nfu_stringToInt32(), nfu_stringToListOfDoubles(), nfu_stringToListOfInt32s(), ptwX_abs(), ptwX_add_double(), ptwX_add_ptwX(), ptwX_ascendingOrder(), ptwX_clone(), ptwX_close(), ptwX_closesDifferenceInRange(), ptwX_compare(), ptwX_copy(), ptwX_countOccurrences(), ptwX_create(), ptwX_createLine(), ptwX_deletePoints(), ptwX_fromString(), ptwX_getPointAtIndex(), ptwX_initialize(), ptwX_insertPointsAtIndex(), ptwX_length(), ptwX_mul_double(), ptwX_neg(), ptwX_new(), ptwX_range(), ptwX_reallocatePoints(), ptwX_reverse(), ptwX_setData(), ptwX_setPointAtIndex(), ptwX_slice(), ptwX_slopeOffset(), ptwX_sort(), ptwX_sub_ptwX(), ptwX_unique(), ptwXY_abs(), ptwXY_add_double(), ptwXY_add_ptwXY(), ptwXY_appendXY(), ptwXY_applyFunction(), ptwXY_areDomainsMutual(), ptwXY_binary_ptwXY(), ptwXY_clear(), ptwXY_clip(), ptwXY_clone(), ptwXY_clone2(), ptwXY_cloneToInterpolation(), ptwXY_coalescePoints(), ptwXY_convolution(), ptwXY_copy(), ptwXY_copyPointsOnly(), ptwXY_copyToC_XY(), ptwXY_create(), ptwXY_createFrom_Xs_Ys(), ptwXY_createFromFunction(), ptwXY_createFromFunction2(), ptwXY_createGaussian(), ptwXY_createGaussianCenteredSigma1(), ptwXY_deletePoints(), ptwXY_div_doubleFrom(), ptwXY_div_fromDouble(), ptwXY_div_ptwXY(), ptwXY_domainMax(), ptwXY_domainMaxAndFrom(), ptwXY_domainMaxSlice(), ptwXY_domainMin(), ptwXY_domainMinAndFrom(), ptwXY_domainMinSlice(), ptwXY_domainSlice(), ptwXY_dullEdges(), ptwXY_equalProbableBins(), ptwXY_exp(), ptwXY_f_integrate(), ptwXY_flatInterpolationToLinear(), ptwXY_fromString(), ptwXY_fromUnitbase(), ptwXY_getLowerIndexBoundingX(), ptwXY_getNonOverflowLength(), ptwXY_getPointAtIndex(), ptwXY_getPointsAroundX(), ptwXY_getPointsAroundX_closeIsEqual(), ptwXY_getSlopeAtX(), ptwXY_getValueAtX(), ptwXY_getXArray(), ptwXY_getXYPairAtIndex(), ptwXY_groupOneFunction(), ptwXY_groupThreeFunctions(), ptwXY_groupTwoFunctions(), ptwXY_initialize(), ptwXY_integrate(), ptwXY_integrateDomain(), ptwXY_integrateDomainWithWeight_sqrt_x(), ptwXY_integrateDomainWithWeight_x(), ptwXY_integrateWithFunction(), ptwXY_integrateWithWeight_sqrt_x(), ptwXY_integrateWithWeight_x(), ptwXY_interpolatePoint(), ptwXY_intersectionWith_ptwX(), ptwXY_inverse(), ptwXY_length(), ptwXY_mapToXsAndAdd(), ptwXY_mergeClosePoints(), ptwXY_mergeFromXsAndYs(), ptwXY_mergeFromXYs(), ptwXY_mod(), ptwXY_mul2_ptwXY(), ptwXY_mul_double(), ptwXY_mul_ptwXY(), ptwXY_mutualifyDomains(), ptwXY_neg(), ptwXY_new(), ptwXY_normalize(), ptwXY_pow(), ptwXY_range(), ptwXY_rangeMax(), ptwXY_rangeMin(), ptwXY_reallocateOverflowPoints(), ptwXY_reallocatePoints(), ptwXY_runningIntegral(), ptwXY_scaleAndOffsetDomainWith_ptwXYs(), ptwXY_scaleOffsetXAndY(), ptwXY_setValueAtX(), ptwXY_setValueAtX_overrideIfClose(), ptwXY_setXYData(), ptwXY_setXYDataFromXsAndYs(), ptwXY_setXYPairAtIndex(), ptwXY_simpleCoalescePoints(), ptwXY_slice(), ptwXY_slopeOffset(), ptwXY_startIndex(), ptwXY_sub_doubleFrom(), ptwXY_sub_fromDouble(), ptwXY_sub_ptwXY(), ptwXY_thicken(), ptwXY_thin(), ptwXY_thinDomain(), ptwXY_toOtherInterpolation(), ptwXY_toUnitbase(), ptwXY_trim(), ptwXY_tweakDomainsToMutualify(), ptwXY_union(), ptwXY_unitbaseInterpolate(), ptwXY_valuesToC_XsAndYs(), ptwXY_valueTo_ptwXY(), and ptwXY_ysMappedToXs().