CUDPP 1.1
Static Public Member Functions
CUDPPPlanManager Class Reference

Singleton manager class for CUDPPPlan objects. More...

#include <cudpp_plan_manager.h>

List of all members.

Static Public Member Functions

static CUDPPHandle AddPlan (CUDPPPlan *plan)
 Add a plan to the plan manager.
static bool RemovePlan (CUDPPHandle handle)
 Remove a plan from the plan manager.
static CUDPPPlanGetPlan (CUDPPHandle handle)
 Get a plan from the plan manager by handle.

Detailed Description

Singleton manager class for CUDPPPlan objects.

This class manages all active plans in CUDPP. It is a singleton class, meaning that only one instance can exist. It is created automatically the first time AddPlan() is called, and destroyed when the last plan is removed using RemovePlan().


Member Function Documentation

CUDPPHandle CUDPPPlanManager::AddPlan ( CUDPPPlan plan) [static]

Add a plan to the plan manager.

Returns:
a valid CUDPPHandle if the plan was successfully added, or CUDPP_INVALID_HANDLE otherwise
Parameters:
[in]planThe plan to add
bool CUDPPPlanManager::RemovePlan ( CUDPPHandle  handle) [static]

Remove a plan from the plan manager.

Returns:
true if the plan was successfully removed, false otherwise
Parameters:
[in]handleThe handle to the plan to remove
CUDPPPlan * CUDPPPlanManager::GetPlan ( CUDPPHandle  handle) [static]

Get a plan from the plan manager by handle.

Returns:
A pointer to the plan if found, or NULL otherwise
Parameters:
handleThe handle to the requested plan

The documentation for this class was generated from the following files:
 All Classes Files Functions Variables Enumerations Enumerator Defines