Procedures

ProcedureLocationProcedure TypeDescription
allocatem_allocateInterface

Allocate an allocatable array. If the array is already allocated, memory is reallocated to the given size, unless no size change will occur. The allocated memory is NOT initialized to any value, so be sure to do so afterwards if you call allocate.

allocate_testm_testsSubroutine
appendStringm_stringsFunction

Append a string

arangem_array1DInterface

Create a 1D array from start to stop in given increments of 1 or optionally step

argInsertionsortm_sortInterface

Perform an indirect insertion sort on an array

argMedianOf3m_medianOf3Interface

Sort the indices of three numbers into an array and return the location of the median

argPartitionm_partitionInterface

Partitioning used for argQuicksort routines

argSelectm_selectInterface

Use an indirect introspection sort on an array of numbers

argSortm_sortInterface

Use an indirect introspection sort on an array of numbers

array1D_testm_testsSubroutine
binarySearchm_searchingInterface

Perform a binary search. See m_searching for more information on how to use this interface

checkIsOpenm_fileIOSubroutine

Checks whether a file is open with an error message if not

closeFilem_fileIOSubroutine

Close a file and perform any necessary checks

compactm_stringsSubroutine

Replace tabs and spaces with a single space str must be a variable and not an explicit 'string'. Otherwise adjustl will fail.

comparem_compareInterface
compare_d1m_compareFunction
copym_copyInterface

Copies an array to new memory (no pointers), The output array size will be changed to match the copy.

copy_testm_testsSubroutine
countEntriesm_stringsFunction

Count the number of entries in a string

crossproductm_mathsInterface

Compute the cross product between two arrays of length 2 or 3

cumprodm_mathsInterface

Compute the variance of an array

cumsumm_mathsInterface

Compute the variance of an array

dArgDynamicArraydArgDynamicArray_ClassInterface
dArgDynamicArray_testm_testsSubroutine
daysInMonthm_timeFunction

Get the number of days in a month. Accounts for leap years

daysInYearm_timeFunction

Get the number of days in a year, accounts for leap years

dDynamicArraydDynamicArray_ClassInterface
dDynamicArray_testm_testsSubroutine
deallocatem_deallocateInterface

Deallocate an allocatable array.

debugm_debuggingInterface

Interface for printing primitives with a name for debug purposes All may be called using 'call debug(args)'

debug_sm_debuggingSubroutine
deleteFilem_fileIOSubroutine

Deletes a file on disk

diffm_array1DInterface

Compute the difference along an array

eMsgm_errorsSubroutine

Write an Error message. Stops the code

fastTwoDiffm_mathsInterface

Compute the difference two numbers and compute the numerical round-off error. See Shewchuk 1997 Adaptive Precision Floating-Point Arithmetic and Fast Robust Geometric Predicates This should only be used if you know that the magnitude of a is greater than or equal to b, otherwise, you should use the slower twoDiff routine

fastTwoSumm_mathsInterface

Compute the sum of two numbers and compute the numerical round-off error. See Shewchuk 1997 Adaptive Precision Floating-Point Arithmetic and Fast Robust Geometric Predicates This should only be used if you know that the magnitude of a is greater than or equal to b, otherwise, you should use the slower twoSum routine

fErrm_errorsSubroutine

Checks for a file error

fileExistsm_fileIOFunction

Checks whether the file with name fName exists on disk

fileIO_testm_fileIOSubroutine
geometricMeanm_mathsInterface

Compute the geometric mean of a vector

getExtensionm_fileIOFunction

Get the extension of a file

getFileSizem_fileIOFunction

Get the file size in Bytes

getNFileLinesm_fileIOFunction

Counts the number of lines in a file after the number of specified header lines

getRandomSeedPrng_ClassSubroutine

Gets a randomly generated seed by getting the current integer time and then using a splitmix algorithm to generate the necessary number of seeds.

hasExtensionm_fileIOFunction

Checks if a file 'fname' is of type 'extension'

hasNentriesm_stringsFunction

Check that a string has N entries

iachar1Dm_stringsFunction

Use iachar on a full string

iArgDynamicArrayiArgDynamicArray_ClassInterface
iArgDynamicArray_testm_testsSubroutine
idArgDynamicArrayidArgDynamicArray_ClassInterface
idArgDynamicArray_testm_testsSubroutine
idDynamicArrayidDynamicArray_ClassInterface
idDynamicArray_testm_testsSubroutine
iDynamicArrayiDynamicArray_ClassInterface
iDynamicArray_testm_testsSubroutine
ind2subm_indexingFunction

Compute the indices in each dimension from the global index

indexing_testm_testsSubroutine
insertionsortm_sortInterface

Perform an in-place insertion sort on an array

integerBinm_indexingFunction
intervalSearchm_searchingInterface

Perform an interval search on an array Returns a length 3 integer(i32) array where the last two entries are the left and right neighbours The first entry of iout is -1 if the value is not present in the vector Assumes this is sorted!See m_searching for more information on how to use this interface

isLeapYearm_timeFunction

Determine whether the year is a leap year

isOpenm_fileIOFunction

Is the file open or not

isSortedm_array1DInterface

Check that a 1D array is sorted

isStringm_stringsFunction

Match two string together

KdTreem_KdTreeInterface

Overloaded Initializer for a KdTree.

KdTree_testm_testsSubroutine
lowerCasem_stringsFunction

Convert a string to lowercase

maths_testm_testsSubroutine
meanm_mathsInterface

Compute the mean

medianm_mathsInterface

Compute the median of a set of numbers

medianOf3m_medianOf3Interface

Sort three numbers in an array and return the location of the median

mErrm_errorsSubroutine

Checks for successful (de)allocation. Stops the code.

msgm_errorsSubroutine

Write a message

norm1m_mathsInterface

Compute the L1 norm of a set of numbers

normIm_mathsInterface

Compute the Linfinity norm of a set of numbers

openBinaryFilem_fileIOSubroutine

Open an unformatted binary file stat should be 'new','old','unknown','append'

openFilem_fileIOSubroutine

Open a file and perform necessary checks for failure stat should be 'new','old','unknown','append'

partitionm_partitionInterface

Partitioning used for quickSort and quickSelect routines

partition3waym_partition3wayInterface

Partitioning used for quicksort routines

partition3way_d1Dm_partition3waySubroutine

Interfaced with partition()

prependStringm_stringsFunction

Prepend a string

PrngPrng_ClassInterface

Overloaded Initializer for a Prng - Pseudo random number generator. Thread safe, xorshift1024* or xorshift128+ generator than can draw from different distributions. See Prng_Class for more information on how to use this class.

Prng_testm_testsSubroutine

Test the jump capabilities of the xorshift128+ in parallel

ProgressBarProgressBar_ClassInterface
projectm_mathsInterface

Project a vector a onto vector b

random_testm_testsSubroutine
rArgDynamicArrayrArgDynamicArray_ClassInterface
rArgDynamicArray_testm_testsSubroutine
rDynamicArrayrDynamicArray_ClassInterface
rDynamicArray_testm_testsSubroutine
read1Dblem_stringsSubroutine
read1Integerm_stringsSubroutine

Get a single integer from a line, returns an error code if there is more than one entry

readlinem_readlineInterface

Read in multiple items from a line

readlinem_stringsSubroutine

Reads a line from a file, ignoring any comments

reallocatem_reallocateInterface

Reallocate an allocatable array

reallocate_testm_testsSubroutine
removeCommentsm_stringsSubroutine

Removes the text after the ! mark in a string

repeatm_array1DInterface

Repeat each element nRepeat times

replacedelimm_stringsSubroutine

Replace a single character length delimiter in a string

rngExponentialm_randomInterface
rngExponential_d1m_randomSubroutine

Interfaced with rngExponential

rngExponential_d1Dm_randomSubroutine

Interfaced with rngExponential

rngExponential_d2Dm_randomSubroutine

Interfaced with rngExponential

rngExponential_d3Dm_randomSubroutine

Interfaced with rngExponential

rngExponential_unscaled_d1Prng_ClassInterface
rngIntegerm_randomInterface

Generate size(this) random integers starting from imin

rngInteger_i1m_randomSubroutine

Interfaced with rngInteger

rngInteger_i1Dm_randomSubroutine

Interfaced with rngInteger

rngInteger_i2Dm_randomSubroutine

Interfaced with rngInteger

rngInteger_i3Dm_randomSubroutine

Interfaced with rngInteger

rngNormalm_randomInterface
rngNormal_d1m_randomSubroutine

Interfaced with rngNormal

rngNormal_d1Dm_randomSubroutine

Interfaced with rngNormal

rngNormal_d2Dm_randomSubroutine

Interfaced with rngNormal

rngNormal_d3Dm_randomSubroutine

Interfaced with rngNormal

rngUniformm_randomInterface
rngUniform_d1m_randomSubroutine

Interfaced with rngUniform

rngUniform_d1Dm_randomSubroutine

Interfaced with rngUniform

rngUniform_d2Dm_randomSubroutine

Interfaced with rngUniform

rngUniform_d3Dm_randomSubroutine

Interfaced with rngUniform

rngUniform_xorshiftPrng_ClassSubroutine
rngWeibullm_randomInterface
rngWeibull_d1m_randomSubroutine

Interfaced with rngWeibull

rngWeibull_d1Dm_randomSubroutine

Interfaced with rngWeibull

rngWeibull_d2Dm_randomSubroutine

Interfaced with rngWeibull

rngWeibull_d3Dm_randomSubroutine

Interfaced with rngWeibull

secondsToHMSm_timeFunction

Convert a time in seconds to HH:MM:SS.MSEC

selectm_selectInterface

Use an in-place quick select on an array of numbers

select_testm_testsSubroutine
setPrngm_randomInterface
setPrng_withSeedm_randomSubroutine

Interfaced to setPrng() Sets the seed of the random number generator with a specified seed

setPrng_WOseedm_randomSubroutine

Interfaced to setPrng() 'Randomly' sets the seed of the random number generator

shufflem_array1DInterface

Perform Knuth shuffling on an array

simpleSearchm_searchingInterface

Carry out a brute force search on an array for a given number. Returns -1 if the value is not found.

skipFileLinesm_fileIOSubroutine

Skip N lines in a file

sortm_sortInterface

Use an in-place introspection sort on an array of numbers

sorting_testm_testsSubroutine
stdm_mathsInterface

Compute the standard deviation of an array

strm_stringsInterface

Interface to print a string representation of a number The output format options can be set using the printOptions class

strings_testm_testsSubroutine
sub2indm_indexingFunction

Given component indices, get the global vector location.

swapm_swapInterface

Swap the values of two variables

testscaleTest_coretranSubroutine
testerm_unitTesterInterface
time_testm_testsSubroutine
timeInSecondsm_timeFunction

Convert hours minutes seconds etc. to seconds

timeToIntegerm_timeFunction

Convert hours minutes seconds etc. to an integer. Use 64bit to prevent the 2038 problem.

trimExtensionm_fileIOFunction

Trims the extension of a filename

trimmedmeanm_mathsInterface

Compute the Trimmed mean of an array, alpha is a percent value to trim from either end

twoDiffm_mathsInterface

Compute the difference between two numbers and compute the numerical round-off error. See Shewchuk 1997 Adaptive Precision Floating-Point Arithmetic and Fast Robust Geometric Predicates If you know that the magnitude of a is greater than or equal to b, use fastTwoDiff

twoSumm_mathsInterface

Compute the sum of two numbers and compute the numerical round-off error. See Shewchuk 1997 Adaptive Precision Floating-Point Arithmetic and Fast Robust Geometric Predicates If you know that the magnitude of a is greater than or equal to b, use fastTwoSum

upperCasem_stringsFunction

Convert a string to uppercase

variancem_mathsInterface

Compute the variance of an array

wMsgm_errorsSubroutine

Write a Warning message

writelinem_writelineInterface

Write multiple items to a line

call~~graph~~CallGraph interface~str str interface~copy copy proc~kdtree_test KdTree_test proc~msg msg proc~kdtree_test->proc~msg interface~arange arange proc~kdtree_test->interface~arange rngnormal rngnormal proc~kdtree_test->rngnormal argsort argsort proc~kdtree_test->argsort idynamicarray idynamicarray proc~kdtree_test->idynamicarray kdtree kdtree proc~kdtree_test->kdtree interface~shuffle shuffle proc~debug_s debug_s proc~debug_s->interface~str interface~swap swap interface~simplesearch simpleSearch interface~progressbar ProgressBar proc~timetointeger timeToInteger proc~daysinmonth daysInMonth proc~timetointeger->proc~daysinmonth proc~daysinyear daysInYear proc~timetointeger->proc~daysinyear interface~twosum twoSum proc~setprng_woseed setPrng_WOseed prng prng proc~setprng_woseed->prng interface~twodiff twoDiff proc~rngexponential_d2d rngExponential_d2D interface~sort sort proc~getextension getExtension emsg emsg proc~getextension->emsg proc~isleapyear isLeapYear proc~daysinmonth->proc~isleapyear proc~uppercase upperCase proc~rngexponential_d1 rngExponential_d1 proc~rngexponential_d1d rngExponential_d1D interface~insertionsort insertionsort proc~timeinseconds timeInSeconds interface~iargdynamicarray iArgDynamicArray interface~crossproduct crossproduct proc~rngexponential_d3d rngExponential_d3D interface~arginsertionsort argInsertionsort proc~rngweibull_d1d rngWeibull_d1D interface~rngexponential_unscaled_d1 rngExponential_unscaled_d1 interface~rngnormal rngNormal proc~rngnormal_d3d rngNormal_d3D interface~rngnormal->proc~rngnormal_d3d proc~rngnormal_d1 rngNormal_d1 interface~rngnormal->proc~rngnormal_d1 proc~rngnormal_d1d rngNormal_d1D interface~rngnormal->proc~rngnormal_d1d proc~rngnormal_d2d rngNormal_d2D interface~rngnormal->proc~rngnormal_d2d interface~medianof3 medianOf3 proc~read1integer read1Integer proc~compact compact proc~read1integer->proc~compact proc~countentries countEntries proc~countentries->proc~compact interface~select select proc~daysinyear->proc~isleapyear interface~argmedianof3 argMedianOf3 proc~rnginteger_i1 rngInteger_i1 proc~trimextension trimExtension proc~trimextension->emsg proc~compare_d1 compare_d1 interface~deallocate deallocate interface~compare compare interface~compare->proc~compare_d1 proc~rngweibull_d2d rngWeibull_d2D interface~rnguniform rngUniform proc~rnguniform_d1 rngUniform_d1 interface~rnguniform->proc~rnguniform_d1 proc~rnguniform_d1d rngUniform_d1D interface~rnguniform->proc~rnguniform_d1d proc~rnguniform_d2d rngUniform_d2D interface~rnguniform->proc~rnguniform_d2d proc~rnguniform_d3d rngUniform_d3D interface~rnguniform->proc~rnguniform_d3d proc~array1d_test array1D_test proc~array1d_test->proc~msg proc~array1d_test->interface~arange interface~diff diff proc~array1d_test->interface~diff proc~secondstohms secondsToHMS proc~deletefile deleteFile interface~reallocate reallocate proc~getfilesize getFileSize proc~fileexists fileExists proc~getfilesize->proc~fileexists interface~allocate allocate interface~argpartition argPartition proc~getnfilelines getNFileLines proc~skipfilelines skipFileLines proc~getnfilelines->proc~skipfilelines proc~openfile openFile proc~getnfilelines->proc~openfile proc~closefile closeFile proc~getnfilelines->proc~closefile proc~rnginteger_i1d rngInteger_i1D proc~read1dble read1Dble proc~read1dble->interface~str proc~read1dble->proc~compact proc~readline readline proc~read1dble->proc~readline ferr ferr proc~read1dble->ferr wmsg wmsg proc~read1dble->wmsg proc~lowercase lowerCase interface~cumsum cumsum interface~rngweibull rngWeibull interface~rngweibull->proc~rngweibull_d1d interface~rngweibull->proc~rngweibull_d2d proc~rngweibull_d3d rngWeibull_d3D interface~rngweibull->proc~rngweibull_d3d proc~rngweibull_d1 rngWeibull_d1 interface~rngweibull->proc~rngweibull_d1 proc~hasnentries hasNentries proc~hasnentries->proc~countentries proc~setprng_withseed setPrng_withSeed proc~setprng_withseed->prng interface~repeat repeat proc~getrandomseed getRandomSeed proc~getrandomseed->emsg timetointeger timetointeger proc~getrandomseed->timetointeger interface~rdynamicarray rDynamicArray proc~rnginteger_i3d rngInteger_i3D proc~rnginteger_i2d rngInteger_i2D proc~removecomments removeComments proc~ind2sub ind2sub proc~merr mErr proc~emsg eMsg proc~merr->proc~emsg interface~partition3way partition3way proc~partition3way_d1d partition3way_d1D interface~partition3way->proc~partition3way_d1d proc~prng_test Prng_test proc~prng_test->prng omp_get_num_threads omp_get_num_threads proc~prng_test->omp_get_num_threads omp_get_thread_num omp_get_thread_num proc~prng_test->omp_get_thread_num getrandomseed getrandomseed proc~prng_test->getrandomseed interface~geometricmean geometricMean interface~cumprod cumprod proc~partition3way_d1d->interface~swap proc~partition3way_d1d->interface~compare proc~appendstring appendString interface~iddynamicarray idDynamicArray interface~rngexponential rngExponential interface~rngexponential->proc~rngexponential_d2d interface~rngexponential->proc~rngexponential_d1 interface~rngexponential->proc~rngexponential_d1d interface~rngexponential->proc~rngexponential_d3d interface~tester tester interface~setprng setPrng interface~setprng->proc~setprng_woseed interface~setprng->proc~setprng_withseed proc~isstring isString proc~isstring->proc~lowercase interface~ddynamicarray dDynamicArray interface~idynamicarray iDynamicArray proc~hasextension hasExtension isstring isstring proc~hasextension->isstring interface~partition partition interface~normi normI proc~openfile->proc~lowercase proc~openfile->proc~compact proc~openfile->emsg proc~openfile->ferr interface~rargdynamicarray rArgDynamicArray proc~sub2ind sub2ind interface~argsort argSort proc~integerbin integerBin idnint idnint proc~integerbin->idnint proc~replacedelim replacedelim proc~replacedelim->emsg proc~rnguniform_xorshift rngUniform_xorshift proc~wmsg wMsg proc~wmsg->proc~msg proc~prependstring prependString interface~norm1 norm1 interface~rnginteger rngInteger interface~rnginteger->proc~rnginteger_i1 interface~rnginteger->proc~rnginteger_i1d interface~rnginteger->proc~rnginteger_i3d interface~rnginteger->proc~rnginteger_i2d proc~emsg->proc~msg proc~checkisopen checkIsOpen proc~isopen isOpen proc~checkisopen->proc~isopen proc~checkisopen->ferr proc~test test interface~fasttwosum fastTwoSum proc~readline->proc~compact interface~project project interface~trimmedmean trimmedmean interface~debug debug interface~idargdynamicarray idArgDynamicArray interface~prng Prng proc~openbinaryfile openBinaryFile proc~openbinaryfile->proc~lowercase proc~openbinaryfile->emsg proc~openbinaryfile->ferr interface~writeline writeline interface~argselect argSelect proc~closefile->proc~lowercase proc~closefile->proc~compact proc~closefile->ferr interface~intervalsearch intervalSearch interface~kdtree KdTree interface~issorted isSorted interface~fasttwodiff fastTwoDiff interface~mean mean proc~iachar1d iachar1D merr merr proc~iachar1d->merr interface~median median interface~binarysearch binarySearch interface~std std interface~variance variance proc~ferr fErr proc~ferr->proc~emsg interface~readline readline interface~dargdynamicarray dArgDynamicArray program~test_coretran test_coretran program~test_coretran->proc~kdtree_test program~test_coretran->proc~array1d_test program~test_coretran->proc~prng_test program~test_coretran->interface~setprng program~test_coretran->emsg proc~rargdynamicarray_test rArgDynamicArray_test program~test_coretran->proc~rargdynamicarray_test proc~random_test random_test program~test_coretran->proc~random_test proc~indexing_test indexing_test program~test_coretran->proc~indexing_test proc~copy_test copy_test program~test_coretran->proc~copy_test proc~iargdynamicarray_test iArgDynamicArray_test program~test_coretran->proc~iargdynamicarray_test proc~strings_test strings_test program~test_coretran->proc~strings_test proc~rdynamicarray_test rDynamicArray_test program~test_coretran->proc~rdynamicarray_test fileio_test fileio_test program~test_coretran->fileio_test proc~dargdynamicarray_test dArgDynamicArray_test program~test_coretran->proc~dargdynamicarray_test proc~time_test time_test program~test_coretran->proc~time_test msg msg program~test_coretran->msg proc~idynamicarray_test iDynamicArray_test program~test_coretran->proc~idynamicarray_test proc~ddynamicarray_test dDynamicArray_test program~test_coretran->proc~ddynamicarray_test proc~allocate_test allocate_test program~test_coretran->proc~allocate_test proc~maths_test maths_test program~test_coretran->proc~maths_test proc~idargdynamicarray_test idArgDynamicArray_test program~test_coretran->proc~idargdynamicarray_test proc~select_test select_test program~test_coretran->proc~select_test proc~reallocate_test reallocate_test program~test_coretran->proc~reallocate_test proc~sorting_test sorting_test program~test_coretran->proc~sorting_test proc~iddynamicarray_test idDynamicArray_test program~test_coretran->proc~iddynamicarray_test program~scaletest_coretran scaleTest_coretran program~scaletest_coretran->interface~str program~scaletest_coretran->interface~sort program~scaletest_coretran->interface~rngnormal program~scaletest_coretran->interface~setprng program~scaletest_coretran->proc~msg program~scaletest_coretran->interface~rnginteger program~scaletest_coretran->kdtree closefile closefile program~scaletest_coretran->closefile binarysearch binarysearch program~scaletest_coretran->binarysearch openfile openfile program~scaletest_coretran->openfile
Help