Memory management for numerical recipes

Collaboration diagram for Memory management for numerical recipes:

Functions
template<class T >
void	ask_Tmatrix (T **&m, int nrl, int nrh, int ncl, int nch)
template<class T >
void	free_Tmatrix (T **&m, int nrl, int nrh, int ncl, int nch)
template<class T >
void	ask_Tvolume (T ***&m, int nsl, int nsh, int nrl, int nrh, int ncl, int nch)
template<class T >
void	free_Tvolume (T ***&m, int nsl, int nsh, int nrl, int nrh, int ncl, int nch)
char *	askMemory (size_t size)
int	freeMemory (void *ptr, size_t memsize)

Detailed Description

Function Documentation

ask_Tmatrix()

template<class T >

void ask_Tmatrix	(	T **&	m,
		int	nrl,
		int	nrh,
		int	ncl,
		int	nch
	)

Ask memory for any type matrix. The valid values range from v[nrl][ncl] to v[nrh][nch]. If no memory is available an exception is thrown. NULL is returned if any nh is not greater than its nl

Definition at line 40 of file xmipp_memory.h.

{
    if (nrh - nrl + 1 >= 1 && nch - ncl + 1 >= 1)
    {
        m = (T **) malloc((unsigned)(nrh - nrl + 1) * sizeof(T*));
        if (!m) REPORT_ERROR(ERR_MEM_NOTENOUGH, "allocation failure 1 in matrix()");
        m -= nrl;

        for (int i = nrl;i <= nrh;i++)
        {
            m[i] = (T *) malloc((unsigned)(nch - ncl + 1) * sizeof(T));
            if (!m[i]) REPORT_ERROR(ERR_MEM_NOTENOUGH, "allocation failure 2 in matrix()");
            m[i] -= ncl;
        }
    }
    else m = NULL;
}

ask_Tvolume()

template<class T >

void ask_Tvolume	(	T ***&	m,
		int	nsl,
		int	nsh,
		int	nrl,
		int	nrh,
		int	ncl,
		int	nch
	)

Ask memory for any type voliume. The valid values range from v[nsl][nrl][ncl] to v[nsh][nrh][nch]. If no memory is available an exception is thrown. NULL is returned if any nh is not greater than its nl.

Definition at line 78 of file xmipp_memory.h.

{
    if (nsh - nsl + 1 >= 1 && nrh - nrl + 1 >= 1 && nch - ncl + 1 >= 1)
    {
        m = (T ***) malloc((unsigned)(nsh - nsl + 1) * sizeof(T**));
        if (!m) REPORT_ERROR(ERR_MEM_NOTENOUGH, "allocation failure 1 in matrix()");
        m -= nsl;

        for (int k = nsl;k <= nsh;k++)
        {
            m[k] = (T **) malloc((unsigned)(nrh - nrl + 1) * sizeof(T*));
            if (!m[k]) REPORT_ERROR(ERR_MEM_NOTENOUGH, "allocation failure 2 in matrix()");
            m[k] -= nrl;

            for (int i = nrl;i <= nrh;i++)
            {
                m[k][i] = (T *) malloc((unsigned)(nch - ncl + 1) * sizeof(T));
                if (!m[k][i]) REPORT_ERROR(ERR_MEM_NOTENOUGH, "allocation failure 2 in matrix()");
                m[k][i] -= ncl;
            }
        }
    }
    else m = NULL;
}

askMemory()

char* askMemory

(

size_t

size

)

Allocates memory. Adapted from Bsofts bfree

It is called exactly like malloc, with the following enhancements:

• If allocation of zero bytes are requested it notifies the user.
• NO LONGER TRUE: Successfully allocated memory is zeroed
• Allocation is attempted and an error message is printed on failure.
• All failures return a NULL pointer to allow error handling from calling functions.

returns char* : a pointer to the memory (NULL on failure)

Definition at line 29 of file xmipp_memory.cpp.

{
    char*  ptr = NULL;

    if ( memsize == 0 )
    {
        REPORT_ERROR(ERR_MEM_BADREQUEST, "Error in askMemory: Memory allocation size requested is zero!");
        return(NULL);
    }

    if ( ( ptr = (char *) calloc(1,memsize*sizeof(char)) ) == NULL )
    {
        REPORT_ERROR(ERR_MEM_NOTENOUGH, formatString("askMemory:: Memory allocation of %lu bytes failed",memsize));
        return(NULL);
    }

    //memset(ptr, 0, memsize);

    return(ptr);
}

free_Tmatrix()

template<class T >

void free_Tmatrix	(	T **&	m,
		int	nrl,
		int	nrh,
		int	ncl,
		int	nch
	)

Free memory associated to any type matrix. After freeing v=NULL

Definition at line 61 of file xmipp_memory.h.

{
    if (m != NULL)
    {
        for (int i = nrh;i >= nrl;i--) {
            free((char*)(m[i] + nrl));
        }
        free((char*)(m));
        m = NULL;
    }
}

free_Tvolume()

template<class T >

void free_Tvolume	(	T ***&	m,
		int	nsl,
		int	nsh,
		int	nrl,
		int	nrh,
		int	ncl,
		int	nch
	)

Free memory associated to any type volume. After freeing v=NULL

Definition at line 106 of file xmipp_memory.h.

{
    if (m != NULL)
    {
        for (int k = nsh;k >= nsl;k--)
        {
            for (int i = nrh;i >= nrl;i--) {
                free((char*)(m[k][i] + ncl));
            }
            free((char*)(m[k] + nrl));
        }
        free((char*)(m + nsl));
        m = NULL;
    }
}

freeMemory()

int freeMemory	(	void *	ptr,
		size_t	memsize
	)

Frees allocated memory. Adapted from Bsofts bfree

It is called exactly like free, with the following enhancements:

• If freeing fails an error message is printed.
• the pointer is reset to NULL

returns int: 0 = success, -1 = failure.

Definition at line 50 of file xmipp_memory.cpp.

{
    if ( ptr == NULL )
        return(0);

    if ( memsize < 1 )
    {
        return(-1);
    }

    free(ptr);
    ptr = NULL;
    return(0);
}