idllib

Personal IDL library for M. Galloy

single page | use frames     summary     class     fields     routine details     file attributes

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

block_size init
example init
type init

Routines

mgcoraggedarray::add, array

Add 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::cleanup

Free resources.

result = mgcoraggedarray::init( [type=integer], example=example [, block_size=integer])

Create a ragged array.

mgcoraggedarray__define

Define instance variables.

Routine details

top source mgcoraggedarray::add

mgcoraggedarray::add, array

Add an array to the ragged array.

Parameters

array in required type=array

array to add

top source 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 source mgcoraggedarray::cleanup

mgcoraggedarray::cleanup

Free resources.

top source 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

top source mgcoraggedarray__define

mgcoraggedarray__define

Define instance variables.

File attributes

Modification date: Mon Nov 29 18:32:28 2010
Lines: 125
Docformat: rst rst
Personal library of Michael Galloy
Contact me if you have enhancement requests or bug fixes.