nf_utilities.h File Reference

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

Go to the source code of this file.

Macros
#define	nf_floatToShortestString_includeSign   ( 1 << 2 )
#define	nf_floatToShortestString_keepPeriod   ( 1 << 1 )
#define	nf_floatToShortestString_trimZeros   ( 1 << 0 )
#define	NUMERICALFUNCTIONS_SVN_VERSION   110+

Typedefs
typedef enum nfu_status_e	nfu_status

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

Functions
char *	nf_floatToShortestString (double value, int significantDigits, int favorEFormBy, int flags)
void *	nfu_calloc (size_t size, size_t n)
void *	nfu_free (void *p)
double	nfu_getInfinity (double sign)
double	nfu_getNAN (void)
int	nfu_isNAN (double d)
void *	nfu_malloc (size_t size)
void	nfu_printErrorMsg (char *fmt,...)
void	nfu_printMsg (char *fmt,...)
void *	nfu_realloc (size_t size, void *old)
void	nfu_setMemoryDebugMode (int mode)
const char *	nfu_statusMessage (nfu_status status)
nfu_status	nfu_stringToListOfDoubles (char const *str, int64_t *numberConverted, double **doublePtr, char **endCharacter)

Macro Definition Documentation

nf_floatToShortestString_includeSign

#define nf_floatToShortestString_includeSign   ( 1 << 2 )

Definition at line 18 of file nf_utilities.h.

nf_floatToShortestString_keepPeriod

#define nf_floatToShortestString_keepPeriod   ( 1 << 1 )

Definition at line 17 of file nf_utilities.h.

nf_floatToShortestString_trimZeros

#define nf_floatToShortestString_trimZeros   ( 1 << 0 )

Definition at line 16 of file nf_utilities.h.

NUMERICALFUNCTIONS_SVN_VERSION

#define NUMERICALFUNCTIONS_SVN_VERSION   110+

Definition at line 14 of file nf_utilities.h.

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_mallocError
nfu_insufficientMemory
nfu_badIndex
nfu_XNotAscending
nfu_badIndexForX
nfu_XOutsideDomain
nfu_invalidInterpolation
nfu_badSelf
nfu_divByZero
nfu_unsupportedInterpolationConversion
nfu_unsupportedInterpolation
nfu_empty
nfu_tooFewPoints
nfu_domainsNotMutual
nfu_badInput
nfu_badNorm
nfu_badIntegrationInput
nfu_otherInterpolation
nfu_failedToConverge
nfu_oddNumberOfValues

Definition at line 25 of file nf_utilities.h.

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

Function Documentation

nf_floatToShortestString()

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

Definition at line 66 of file nf_stringToDoubles.cc.

                                                                                                   {
 
    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--; // Loop checking, 11.06.2015, T. Koi
    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--; // Loop checking, 11.06.2015, T. Koi
            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 ) );
}

References e1, e2, e3, isfinite, nf_floatToShortestString_includeSign, nf_floatToShortestString_keepPeriod, nf_floatToShortestString_trimZeros, and G4INCL::Math::sign().

nfu_calloc()

void * nfu_calloc	(	size_t	size,
		size_t	n
	)

Definition at line 123 of file nf_utilities.cc.

                                          {
 
    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 );
}

References CLHEP::detail::n, and nfu_debugging.

Referenced by ptwX_new(), ptwXY_new(), and ptwXY_thin().

nfu_free()

void * nfu_free

(

void *

p

)

Definition at line 143 of file nf_utilities.cc.

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

References free, and nfu_debugging.

Referenced by nf_Legendre_free(), nf_Legendre_new(), nf_Legendre_release(), ptwX_free(), ptwX_fromString(), ptwX_new(), ptwX_release(), ptwXY_cloneToInterpolation(), ptwXY_copy(), ptwXY_free(), ptwXY_fromString(), ptwXY_mergeFrom(), ptwXY_mergeFromXYs(), ptwXY_new(), ptwXY_release(), and ptwXY_thin().

nfu_getInfinity()

double nfu_getInfinity

(

double

sign

)

Definition at line 68 of file nf_utilities.cc.

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

References G4INCL::Math::sign().

nfu_getNAN()

double nfu_getNAN

(

void

)

Definition at line 54 of file nf_utilities.cc.

                          {
 
    return( NAN );
}

Referenced by ptwXY_div_ptwXY(), ptwXY_getXMaxAndFrom(), and ptwXY_getXMinAndFrom().

nfu_isNAN()

int nfu_isNAN

(

double

d

)

Definition at line 61 of file nf_utilities.cc.

                          {
 
    return( is_nan( d ) );
}

References is_nan.

Referenced by ptwXY_div_ptwXY().

nfu_malloc()

void * nfu_malloc

(

size_t

size

)

Definition at line 113 of file nf_utilities.cc.

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

References nfu_debugging.

Referenced by nf_Legendre_new(), nfu_stringToListOfDoubles2(), ptwXY_mergeFrom(), and ptwXY_mergeFromXYs().

nfu_printErrorMsg()

void nfu_printErrorMsg	(	char *	fmt,
			...
	)

Definition at line 166 of file nf_utilities.cc.

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

References args, and g4zmq::exit().

nfu_printMsg()

void nfu_printMsg	(	char *	fmt,
			...
	)

Definition at line 154 of file nf_utilities.cc.

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

References args.

nfu_realloc()

void * nfu_realloc	(	size_t	size,
		void *	old
	)

Definition at line 133 of file nf_utilities.cc.

                                            {
 
    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 );
}

References nfu_debugging.

Referenced by nf_Legendre_reallocateCls(), ptwX_reallocatePoints(), ptwXY_reallocateOverflowPoints(), and ptwXY_reallocatePoints().

nfu_setMemoryDebugMode()

void nfu_setMemoryDebugMode

(

int

mode

)

Definition at line 106 of file nf_utilities.cc.

                                        {
 
    nfu_debugging = mode;
}

References nfu_debugging.

nfu_statusMessage()

const char * nfu_statusMessage

(

nfu_status

status

)

Definition at line 76 of file nf_utilities.cc.

                                                   {
 
    switch( status ) {
    case nfu_Okay : return( Okay_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_failedToConverge : return( failedToConverge_message );
    case nfu_oddNumberOfValues : return( oddNumberOfValues_message );
    }
    return( unknownStatus_message );
}

References badIndex_message, badIndexForX_message, badInput_message, badIntegrationInput_message, badNorm_message, badSelf_message, divByZero_message, empty_message, failedToConverge_message, insufficientMemory_message, invalidInterpolation_message, mallocError_message, nfu_badIndex, nfu_badIndexForX, nfu_badInput, nfu_badIntegrationInput, nfu_badNorm, nfu_badSelf, nfu_divByZero, nfu_domainsNotMutual, nfu_empty, nfu_failedToConverge, nfu_insufficientMemory, nfu_invalidInterpolation, nfu_mallocError, nfu_oddNumberOfValues, nfu_Okay, nfu_otherInterpolation, nfu_tooFewPoints, nfu_unsupportedInterpolation, nfu_unsupportedInterpolationConversion, nfu_XNotAscending, nfu_XOutsideDomain, notMutualDomian_message, oddNumberOfValues_message, Okay_message, otherInterpolation_message, tooFewPoints_message, unknownStatus_message, unsupportedInterpolation_message, unsupportedInterpolationConversion_message, XNotAscending_message, and XOutsideDomain_message.

Referenced by MCGIDI_angular_parseFromTOM(), MCGIDI_angularEnergy_parsePointwiseFromTOM(), MCGIDI_energy_parseMadlandNixFromTOM(), MCGIDI_energy_parseNBodyPhaseSpaceFromTOM(), MCGIDI_energyAngular_linear_parseFromTOM(), MCGIDI_fromTOM_pdfOfX(), MCGIDI_KalbachMann_parseFromTOM2(), MCGIDI_LLNL_angularEnergy_parsePointwiseFromTOM(), MCGIDI_misc_Data2ptwXYPointsInUnitsOf(), MCGIDI_product_parseFromTOM(), MCGIDI_product_parsePolynomialMultiplicity(), MCGIDI_target_heated_read(), and MCGIDI_target_heated_recast().

nfu_stringToListOfDoubles()

nfu_status nfu_stringToListOfDoubles	(	char const *	str,
		int64_t *	numberConverted,
		double **	doublePtr,
		char **	endCharacter
	)

Definition at line 29 of file nf_stringToDoubles.cc.

                                                                                                                           {
 
    *numberConverted = 0;
    *doublePtr = NULL;
    return( nfu_stringToListOfDoubles2( str, numberConverted, doublePtr, endCharacter ) );
}

References nfu_stringToListOfDoubles2().

Referenced by ptwX_fromString(), and ptwXY_fromString().