NuPIC Core
Core algorithms for NuPIC(the Numenta Platform for Intelligent Computing), implemented in C++
 All Classes Namespaces Files Functions Typedefs Enumerations Enumerator Friends Pages
Classes | Typedefs | Enumerations
nta Namespace Reference

Contains the primary NuPIC API. More...

Classes

class  Dimensions
 Represents the dimensions of a Region. More...
 
class  Input
 Represents a named input to a Region. More...
 
class  Link
 Represents a link between regions in a Network. More...
 
class  Network
 Represents an HTM network. More...
 
class  NuPIC
 Initialization and shutdown operations for NuPIC engine. More...
 
class  Output
 Represents a named output to a Region. More...
 
class  Region
 Represents a set of one or more "identical" nodes in a Network. More...
 

Typedefs

typedef std::vector< size_t > Coordinate
 A Coordinate is the location of a single cell in an n-dimensional grid described by a Dimensions object. More...
 
Basic types
typedef NTA_Byte Byte
 Represents a 8-bit byte.
 
typedef NTA_Int16 Int16
 Represents a 16-bit signed integer.
 
typedef NTA_UInt16 UInt16
 Represents a 16-bit unsigned integer.
 
typedef NTA_Int32 Int32
 Represents a 32-bit signed integer.
 
typedef NTA_UInt32 UInt32
 Represents a 32-bit unsigned integer.
 
typedef NTA_Int64 Int64
 Represents a 64-bit signed integer.
 
typedef NTA_UInt64 UInt64
 Represents a 64-bit unsigned integer.
 
typedef NTA_Real32 Real32
 Represents a 32-bit real number(a floating-point number).
 
typedef NTA_Real64 Real64
 Represents a 64-bit real number(a floating-point number).
 
typedef NTA_Handle Handle
 Represents a opaque handle/pointer, same as void *
 
Flexible types

The following are flexible types depending on NTA_DOUBLE_PROCESION and NTA_BIG_INTEGER.

typedef NTA_Real Real
 Represents a real number(a floating-point number). More...
 
typedef NTA_Int Int
 Represents a signed integer. More...
 
typedef NTA_UInt UInt
 Represents a unsigned integer. More...
 
typedef NTA_Size Size
 Represents lengths of arrays, strings and so on.
 

Enumerations

enum  LogLevel { LogLevel_None = NTA_LogLevel_None, LogLevel_Minimal, LogLevel_Normal, LogLevel_Verbose }
 This enum represents the documented logging level of the debug logger. More...
 

Detailed Description

Contains the primary NuPIC API.

Typedef Documentation

A Coordinate is the location of a single cell in an n-dimensional grid described by a Dimensions object.

It's a direct typedef, so it has the exactly the same interface as std::vector<size_t> . A value with the index of i in the vector represents the location of the cell along the ith dimension.

Note
It must have the same number of dimensions as its corresponding Dimensions object.

Definition at line 56 of file Dimensions.hpp.

typedef NTA_Int nta::Int

Represents a signed integer.

Same as nta::Int64 if NTA_BIG_INTEGER is defined, nta::Int32 otherwise.

Definition at line 118 of file Types.hpp.

Represents a real number(a floating-point number).

Same as nta::Real64 if NTA_DOUBLE_PROCESION is defined, nta::Real32 otherwise.

Definition at line 111 of file Types.hpp.

Represents a unsigned integer.

Same as nta::UInt64 if NTA_BIG_INTEGER is defined, nta::UInt32 otherwise.

Definition at line 125 of file Types.hpp.

Enumeration Type Documentation

This enum represents the documented logging level of the debug logger.

Use it like LDEBUG(nta::LogLevel_XXX).

Enumerator
LogLevel_None 

Log level: None.

LogLevel_Minimal 

Log level: Minimal.

LogLevel_Normal 

Log level: Normal.

LogLevel_Verbose 

Log level: Verbose.

Definition at line 141 of file Types.hpp.