NuPIC  0.3.0.dev0
Numenta Platform for Intelligent Computing
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | List of all members
Connections Class Reference

Class to hold data representing the connectivity of a collection of cells. More...

Inherits object.

Public Member Functions

def __init__
 
def cellForSegment
 Returns the cell that a segment belongs to. More...
 
def segmentsForCell
 Returns the segments that belong to a cell. More...
 
def dataForSynapse
 Returns the data for a synapse. More...
 
def synapsesForSegment
 Returns the synapses on a segment. More...
 
def synapsesForPresynapticCell
 Returns the synapses for the source cell that they synapse on. More...
 
def createSegment
 Adds a new segment on a cell. More...
 
def destroySegment
 Destroys a segment. More...
 
def createSynapse
 Creates a new synapse on a segment. More...
 
def destroySynapse
 Destroys a synapse. More...
 
def updateSynapsePermanence
 Updates the permanence for a synapse. More...
 
def numSegments
 Returns the number of segments.
 
def numSynapses
 Returns the number of synapses.
 

Detailed Description

Class to hold data representing the connectivity of a collection of cells.

Constructor & Destructor Documentation

def __init__ (   self,
  numCells 
)
Parameters
numCells(int) Number of cells in collection

Member Function Documentation

def cellForSegment (   self,
  segment 
)

Returns the cell that a segment belongs to.

Parameters
segment(int) Segment index
Returns
(int) Cell index
def createSegment (   self,
  cell 
)

Adds a new segment on a cell.

Parameters
cell(int) Cell index
Returns
(int) New segment index
def createSynapse (   self,
  segment,
  presynapticCell,
  permanence 
)

Creates a new synapse on a segment.

Parameters
segment(int) Segment index
presynapticCell(int) Source cell index
permanence(float) Initial permanence
Returns
(int) Synapse index
def dataForSynapse (   self,
  synapse 
)

Returns the data for a synapse.

Parameters
synapse(int) Synapse index
Returns
(SynapseData) Synapse data
def destroySegment (   self,
  segment 
)

Destroys a segment.

Parameters
segment(int) Segment index
def destroySynapse (   self,
  synapse 
)

Destroys a synapse.

Parameters
synapse(int) Synapse index
def segmentsForCell (   self,
  cell 
)

Returns the segments that belong to a cell.

Parameters
cell(int) Cell index
Returns
(set) Segment indices
def synapsesForPresynapticCell (   self,
  presynapticCell 
)

Returns the synapses for the source cell that they synapse on.

Parameters
presynapticCell(int) Source cell index
Returns
(set) Synapse indices
def synapsesForSegment (   self,
  segment 
)

Returns the synapses on a segment.

Parameters
segment(int) Segment index
Returns
(set) Synapse indices
def updateSynapsePermanence (   self,
  synapse,
  permanence 
)

Updates the permanence for a synapse.

Parameters
synapse(int) Synapse index
permanence(float) New permanence

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