SqueezeBrains SDK 1.18
sb_cs::Sb Class Reference

Sb Main Class More...

#include <cs_sb.h>

Static Public Member Functions

static SbError Init (String ^ license_file)
 Init the SB Library. The function initializes all the functionalities of the library including the license. More...
 
static SbError InitDl (String^ search_path, SbDlLibraryType LibType)
 Init the Deep Learning SB Library. The function enables the SbProject::Detection and SVL functions for the SbProjectType.SB_PROJECT_TYPE_DEEP_CORTEX "Deep Cortex", SbProjectType.SB_PROJECT_TYPE_DEEP_SURFACE "Deep Surface" and SbProjectType.SB_PROJECT_TYPE_DEEP_RETINA "Deep Retina" projects. More...
 
static SbError Release ()
 Releases all the resources allocated in the library More...
 
static SbError CheckMemoryLeak ()
 Checks if the library has a memory leak. More...
 
static SbError CheckMemoryLeakReset ()
 Resets the memory leak control More...
 
static SbInfo GetInfo (int dl_devices_info)
 The function gets information of the sb library and the available computational devices
More...
 
static String FormatDeviceType (SbDeviceType value)
 The function gets the device type description
More...
 
static String FormatFrameworkType (SbFrameworkType value)
 The function gets the framework type description
More...
 

Static Public Attributes

static String SbInitOnlyHwLicenseKey = SB_INIT_ONLY_HW_LICENSE_KEY
 
See also
SB_INIT_ONLY_HW_LICENSE_KEY

 
static String SbInitOnlySbLicenseKey = SB_INIT_ONLY_SB_LICENSE_KEY
 
See also
SB_INIT_ONLY_SB_LICENSE_KEY

 
static String SbInitNoLicenseKey = SB_INIT_NO_LICENSE_KEY
 
See also
SB_INIT_NO_LICENSE_KEY

 

Detailed Description

Sb Main Class

Definition at line 400 of file cs_sb.h.

Member Function Documentation

◆ CheckMemoryLeak()

static SbError sb_cs::Sb::CheckMemoryLeak ( )
static

Checks if the library has a memory leak.

Returns
If successful, returns SbError.SB_ERR_NONE. Otherwise, it returns an error code SbError.
See also
sb_malloc_check_memory_leak

◆ CheckMemoryLeakReset()

static SbError sb_cs::Sb::CheckMemoryLeakReset ( )
static

Resets the memory leak control

Returns
If successful, returns SbError.SB_ERR_NONE. Otherwise, it returns an error code SbError.
See also
sb_malloc_check_memory_leak_reset

◆ FormatDeviceType()

static String sb_cs::Sb::FormatDeviceType ( SbDeviceType  value)
static

The function gets the device type description

Returns
A string containing the device type in a human - readable format.
See also
sb_device_type_format

◆ FormatFrameworkType()

static String sb_cs::Sb::FormatFrameworkType ( SbFrameworkType  value)
static

The function gets the framework type description

Returns
A string containing the framework type in a human - readable format.
See also
sb_framework_type_format

◆ GetInfo()

static SbInfo sb_cs::Sb::GetInfo ( int  dl_devices_info)
static

The function gets information of the sb library and the available computational devices

Returns
An instance to the SbInfo class or null in case of memory error.
The instance returned is valid only if the SbInfo.Error() is equal to SbError::SB_ERR_NONE, otherwise an error occurred.
You must call the Dispose() method to free all the resources of the returned instance.
See also
sb_get_info

◆ Init()

static SbError sb_cs::Sb::Init ( String ^  license_file)
static

Init the SB Library. The function initializes all the functionalities of the library including the license.

Parameters
license_file
Returns
If successful, returns SbError.SB_ERR_NONE. Otherwise, it returns an error code SbError.
See also
sb_init
Sb::SbInitOnlyHwLicenseKey
Sb::SbInitOnlySbLicenseKey
Sb::SbInitNoLicenseKey

◆ InitDl()

static SbError sb_cs::Sb::InitDl ( String^  search_path,
SbDlLibraryType  LibType 
)
static

Init the Deep Learning SB Library. The function enables the SbProject::Detection and SVL functions for the SbProjectType.SB_PROJECT_TYPE_DEEP_CORTEX "Deep Cortex", SbProjectType.SB_PROJECT_TYPE_DEEP_SURFACE "Deep Surface" and SbProjectType.SB_PROJECT_TYPE_DEEP_RETINA "Deep Retina" projects.

Parameters
search_pathAdditional paths used to specify where SB Deep Learning framework dependencies are located
LibTypeDeep Learning library to initialize
Returns
If successful, returns SbError.SB_ERR_NONE. If libraries dependencies are not satisfied, SbError::SB_ERR_LIBRARY_DEPENDENCIES Otherwise, it returns an error code SbError.
See also
sb_init_dl
Sb::Init

◆ Release()

static SbError sb_cs::Sb::Release ( )
static

Releases all the resources allocated in the library

Returns
If successful, returns SbError.SB_ERR_NONE. Otherwise, it returns an error code SbError.
See also
sb_release

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