Docs

NAME

closeId - release kernel object

SYNOPSIS

function closeId(id);

DESCRIPTION

The function is used to release kernel object by removing it's id from KernelObjectTable, so it can not be addressed from script anymore. Numerical value stored in id becomes invalid when the function returns. The call of closeId also decreases object's reference counter by one. When the counter reaches zero, the object will be deleted.

RETURN VALUES

None.

NOTES

All the remaining objects will be correctly deleted upon the script's completion.

EXAMPLES

A simple case:

id = createActFunc(ACT_FUNC.LINEAR, 1.0, 0.0);
closeId(id); -- Activation function will be released and then deleted;

Dependant objects case:

-- Create components of the future neuron;
connectorsId = createAbstractConnectors(3);
weightsId = createAbstractWeights(2);
procUnitId = createProcUnit(PROC_UNIT.WEIGHTED_SUM);
actFuncId = createActFunc(ACT_FUNC.LINEAR, 1.0, 0.0);

-- Create the neuron;
neuronId = createAbstractNeuron(2, {0, 1}, connectorsId, 2, weightsId, 0, procUnitId, actFuncId);

-- Release objects in arbitrary order;
closeId(weightsId);    -- Weights object will be released but not deleted;
closeId(connectorsId); -- Connectors object will be released but not deleted;
closeId(procUnitId);   -- Processing unit will be released but not deleted;
closeId(neuronId);     -- Neuron, weights, connectors and processing unit will be deleted;
closeId(actFuncId);    -- Activation function will be released and then deleted;