collection/
mgcoraggedarray__define.pro
This class represents an array where each element is another array (of differing sizes).
Class description for mgcoraggedarray
Inheritance
All ancestor classes: mgcoabstractlist idl_object
Properties
Properties in mgcoraggedarray
- block_size init
- example init
- type init
Routines
Methods inherited from idl_object
Methods inherited from mgcoabstractlist
mgcoabstractlist::add, elements [, position=integer]result = mgcoabstractlist::isContained(elements [, position=long])result = mgcoabstractlist::init()mgcoabstractlist::move, source, destinationresult = mgcoabstractlist::iterator()result = mgcoabstractlist::count()result = mgcoabstractlist::get( [/all] [, position=integer] [, count=integer] [, isa=string or strarr])mgcoabstractlist::getProperty [, version=long]mgcoabstractlist::remove [, elements] [, position=long] [, /all]mgcoabstractlist::cleanup
Routines from mgcoraggedarray__define.pro
mgcoraggedarray::add, arrayAdd an array to the ragged array.
result = mgcoraggedarray::get( [/all] [, position=long] [, count=long] [, isa=string] [, reverse_indices=lonarr] [, /connectivity_list])Get elements of the array.
mgcoraggedarray::cleanupFree resources.
result = mgcoraggedarray::init( [type=integer], example=example [, block_size=integer])Create a ragged array.
mgcoraggedarray__defineDefine instance variables.
Routine details
top mgcoraggedarray::add
mgcoraggedarray::add, array
Add an array to the ragged array.
Parameters
- array in required type=array
array to add
top mgcoraggedarray::get
result = mgcoraggedarray::get( [/all] [, position=long] [, count=long] [, isa=string] [, reverse_indices=lonarr] [, /connectivity_list])
Get elements of the array.
Return value
element(s)
Keywords
- all in optional type=boolean
set to return all elements
- position in optional type=long
position of element to return
- count out optional type=long
number of elements returned
- isa in optional type=string
classname to test elements for
- reverse_indices out optional type=lonarr
when a named variable is present routine returns HISTOGRAM type output as the return value and REVERSE_INDICES through this keyword
- connectivity_list in optional type=boolean
set to return a connectivity list format of the results; only valid if the type is a numeric type
top mgcoraggedarray::init
result = mgcoraggedarray::init( [type=integer], example=example [, block_size=integer])
Create a ragged array.
Return value
1B for succes, 0B otherwise
Keywords
- type in optional type=integer
type code as in SIZE function to specify the type of elements in the list; TYPE or EXAMPLE keyword must be used example : in, optional, type=any used to specify the type of the list by example; necessary if defining a list of structures
- example
- block_size in optional type=integer default=1000L
initial size of data array
File attributes
| Modification date: | Wed May 14 15:07:14 2014 |
| Lines: | 38 |
| Docformat: | rst rst |
Contact me if you have enhancement requests or bug fixes.