NEST  2.6.0,not_revisioned_source_dir@0
Public Member Functions | List of all members
SLIArrayModule::Area2Function Class Reference

Return array of indices defining a 2d subarea of a 2d array. More...

Inheritance diagram for SLIArrayModule::Area2Function:
SLIFunction

Public Member Functions

void execute (SLIInterpreter *) const
 
- Public Member Functions inherited from SLIFunction
 SLIFunction ()
 
virtual ~SLIFunction ()
 
virtual void backtrace (SLIInterpreter *, int) const
 Show stack backtrace information on error. More...
 

Detailed Description

Return array of indices defining a 2d subarea of a 2d array.

Given a – hypothetical – twodimensional array, "area" tells you, what indices you need to subscript a contiguous, twodimensional subarea. Returns 2-d indices.

For further information refer to the SLI documentation.

Synopsis:
source_anchor_y source_anchor_x area_height area_width area_anchor_y area_anchor_x area -> [1d-indices]
Parameters
source_anchor_yy position of the anchor point relative to ORIGIN OF THE SOURCE ARRAY
source_anchor_xx position of the anchor point relative to ORIGIN OF THE SOURCE ARRAY
area_heightheight of the subarea to be subscribed
area_widthwidth of the subarea to be subscribed
area_anchor_yy position of the anchor point relative to ORIGIN OF THE SUBAREA
area_anchor_xx position of the anchor point relative to ORIGIN OF THE SUBAREA
Returns
[2d-indices] flat integer array containing the indices that can be used to subscript the (hypothetical) source array in order to access the desired subarea.

Member Function Documentation

void SLIArrayModule::Area2Function::execute ( SLIInterpreter i) const
virtual

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