ViennaCL - The Vienna Computing Library  1.5.2
Public Member Functions
tuning_param Class Reference

class for a tuning parameter More...

#include <autotune.hpp>

Public Member Functions

 tuning_param (std::vector< int > const &values)
 The constructor. More...
 
bool is_max () const
 Returns true if the parameter has reached its maximum value. More...
 
bool inc ()
 Increments the parameter. More...
 
int current () const
 Returns the current value of the parameter. More...
 
void reset ()
 Resets the parameter to its minimum value. More...
 

Detailed Description

class for a tuning parameter

Constructor & Destructor Documentation

tuning_param ( std::vector< int > const &  values)
inline

The constructor.

Parameters
valuesThe set of values which this particular tuning parameter can take

Member Function Documentation

int current ( ) const
inline

Returns the current value of the parameter.

bool inc ( )
inline

Increments the parameter.

bool is_max ( ) const
inline

Returns true if the parameter has reached its maximum value.

void reset ( )
inline

Resets the parameter to its minimum value.


The documentation for this class was generated from the following file: