NAG C Library Function Document

nag_mv_dend_free (g03xzc)

1
Purpose

nag_mv_dend_free (g03xzc) frees Nag allocated memory for the dendrogram array in nag_mv_dendrogram (g03ehc).

2
Specification

#include <nag.h>
#include <nagg03.h>
void  nag_mv_dend_free (char ***c)

3
Description

Memory is allocated internally by nag_mv_dendrogram (g03ehc) to an array of character pointers, containing consecutive lines of the dendrogram.
nag_mv_dend_free (g03xzc) can be used to free this memory and set the value of the individual pointers in the array of character pointers to NULL.
Please note that the standard C function free() must not be used to free this memory.

4
References

None.

5
Arguments

1:     c char ***Input/Output
On entry: a pointer to an array of character pointers to which memory has been allocated internally by nag_mv_dendrogram (g03ehc).
On exit: the memory allocated to each of the pointers in the pointer array is freed and the pointers are set to NULL.

6
Error Indicators and Warnings

None.

7
Accuracy

Not applicable.

8
Parallelism and Performance

nag_mv_dend_free (g03xzc) is not threaded in any implementation.

9
Further Comments

None.

10
Example

See Section 10 in nag_mv_dendrogram (g03ehc).