Documentation - C API

kmeans.c File Reference

K-means - Declaration. More...

#include "kmeans.h"
#include "generic.h"
#include "mathop.h"
#include <string.h>
#include "shuffle-def.h"
#include "kmeans.c"
#include "qsort-def.h"

Go to the source code of this file.

Functions

void vl_kmeans_reset (VlKMeans *self)
 Reset state.
VlKMeansvl_kmeans_new (vl_type dataType, VlVectorComparisonType distance)
 Create a new KMeans object.
VlKMeansvl_kmeans_new_copy (VlKMeans const *kmeans)
 Create a new KMeans object by copy.
void vl_kmeans_delete (VlKMeans *self)
 Deletes a KMeans object.

Detailed Description

Author:
Andrea Vedaldi

Definition in file kmeans.c.


Function Documentation

void vl_kmeans_delete ( VlKMeans self  ) 
Parameters:
self KMeans object instance.

The function deletes the KMeans object instance created by vl_kmeans_new.

Definition at line 275 of file kmeans.c.

References vl_free(), and vl_kmeans_reset().

VlKMeans* vl_kmeans_new ( vl_type  dataType,
VlVectorComparisonType  distance 
)
Parameters:
dataType type of data (VL_TYPE_FLOAT or VL_TYPE_DOUBLE)
distance distance.
Returns:
new KMeans object instance.

Definition at line 206 of file kmeans.c.

References vl_kmeans_reset(), vl_malloc(), and VlKMeansLLoyd.

void vl_kmeans_reset ( VlKMeans self  ) 

The function reset the state of the KMeans object. It deletes any stored centers, releasing the corresponding memory. This cancels the effect of seeding or setting the centers, but does not change the other configuration parameters.

Definition at line 187 of file kmeans.c.

References vl_free().

Referenced by vl_kmeans_delete(), and vl_kmeans_new().