Public Member Functions | Public Attributes

trial_generator Class Reference

Class to generate a set of trials for clustering. More...

#include <trial.h>

Collaboration diagram for trial_generator:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 trial_generator (size_t _max_k, size_t _max_reps, size_t _init_size, size_t _num_objects)
 Constructor to generate trials from 1 to max_k.
 trial_generator (size_t min_k, size_t _max_k, size_t _max_reps, size_t _init_size, size_t _num_objects)
 Constructor to generate trials from min_k to max_k.
size_t count () const
 return iterations so far.
bool has_next () const
 whether there are trials remaining.
trial next ()
 return parameters for next trial
void reset ()
 return to initial state
size_t num_trials ()
 Return total number of trials this will generate.

Public Attributes

const size_t max_k
 maximum k to try
const size_t max_reps
 max number of repetitions per k
const size_t init_size
 initial size for samples before factoring in k, as per CLARA paper.
const size_t num_objects
 number of elements in the data set; determines maximum sample size.

Detailed Description

Class to generate a set of trials for clustering.

This packages up state for the main trial loop and allows work to be farmed out to worker processes.

Definition at line 70 of file trial.h.


Constructor & Destructor Documentation

trial_generator ( size_t  _max_k,
size_t  _max_reps,
size_t  _init_size,
size_t  _num_objects 
)

Constructor to generate trials from 1 to max_k.

Definition at line 54 of file trial.cpp.

trial_generator ( size_t  min_k,
size_t  _max_k,
size_t  _max_reps,
size_t  _init_size,
size_t  _num_objects 
)

Constructor to generate trials from min_k to max_k.

Definition at line 66 of file trial.cpp.


Member Function Documentation

size_t count (  ) const

return iterations so far.

Definition at line 105 of file trial.cpp.

bool has_next (  ) const

whether there are trials remaining.

Definition at line 79 of file trial.cpp.

trial next (  )

return parameters for next trial

Definition at line 84 of file trial.cpp.

size_t num_trials (  )

Return total number of trials this will generate.

Definition at line 101 of file trial.cpp.

void reset (  )

return to initial state


Member Data Documentation

const size_t init_size

initial size for samples before factoring in k, as per CLARA paper.

Definition at line 91 of file trial.h.

const size_t max_k

maximum k to try

Definition at line 89 of file trial.h.

const size_t max_reps

max number of repetitions per k

Definition at line 90 of file trial.h.

const size_t num_objects

number of elements in the data set; determines maximum sample size.

Definition at line 92 of file trial.h.


The documentation for this class was generated from the following files:
Muster. Copyright © 2010, Lawrence Livermore National Laboratory, LLNL-CODE-433662.
Distribution of Muster and its documentation is subject to terms of the Muster LICENSE.
Generated on Mon Dec 20 2010 using Doxygen 1.7.2