mglib

Personal IDL library for M. Galloy

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

collection/

mgcoset__define.pro


Other file information

Requires:

IDL 8.0

Class description for mgcoset

Inheritance

Routines

Methods inherited from idl_object

Routines from mgcoset__define.pro

result = mgcoset::_overloadForeach(value, key)

Handle iterating over the elements in a set.

result = mgcoset::_overloadSize()

Returns the number of elements in the set

result = mgcoset::_overloadMinus(left, right)

Performance set difference.

result = mgcoset::_overloadPlus(left, right)

Performance set union.

result = mgcoset::_overloadOr(left, right)

Performance set union.

result = mgcoset::_overloadAnd(left, right)

Performance set union.

result = mgcoset::_overloadBracketsRightSide(isRange, ss1, ss2, ss3, ss4, ss5, ss6, ss7, ss8)
result = mgcoset::_overloadIsTrue()
result = mgcoset::_overloadPrint()
result = mgcoset::_overloadHelp(varname)
result = mgcoset::contains(el)
mgcoset::remove, elements, all=all
mgcoset::add, elements
mgcoset::cleanup
result = mgcoset::init(elements)
mgcoset__define

Routine details

top mgcoset::_overloadForeach

result = mgcoset::_overloadForeach(value, key)

Handle iterating over the elements in a set.

Return value

1 if there is a current element to retrieve, 0 if not

Parameters

value in required type=scalar numeric

return value for the iteration

key in required type=undefined or long

undefined on initial item and row index for subsequent calls

top mgcoset::_overloadSize

result = mgcoset::_overloadSize()

Returns the number of elements in the set

Return value

number of elements in the set

top mgcoset::_overloadMinus

result = mgcoset::_overloadMinus(left, right)

Performance set difference.

Return value

a new set

Parameters

left in required type=set or other iterable

left-side operand

right in required type=set or other iterable

right-side operand

top mgcoset::_overloadPlus

result = mgcoset::_overloadPlus(left, right)

Performance set union.

Return value

a new set

Parameters

left in required type=set or other iterable

left-side operand

right in required type=set or other iterable

right-side operand

top mgcoset::_overloadOr

result = mgcoset::_overloadOr(left, right)

Performance set union.

Return value

a new set

Parameters

left in required type=set or other iterable

left-side operand

right in required type=set or other iterable

right-side operand

top mgcoset::_overloadAnd

result = mgcoset::_overloadAnd(left, right)

Performance set union.

Return value

a new set

Parameters

left in required type=set or other iterable

left-side operand

right in required type=set or other iterable

right-side operand

top mgcoset::_overloadBracketsRightSide

result = mgcoset::_overloadBracketsRightSide(isRange, ss1, ss2, ss3, ss4, ss5, ss6, ss7, ss8)

Parameters

isRange
ss1
ss2
ss3
ss4
ss5
ss6
ss7
ss8

top mgcoset::_overloadIsTrue

result = mgcoset::_overloadIsTrue()

top mgcoset::_overloadPrint

result = mgcoset::_overloadPrint()

top mgcoset::_overloadHelp

result = mgcoset::_overloadHelp(varname)

Parameters

varname

top mgcoset::contains

result = mgcoset::contains(el)

Parameters

el

top mgcoset::remove

mgcoset::remove, elements, all=all

Parameters

elements

Keywords

all

top mgcoset::add

mgcoset::add, elements

Parameters

elements

top mgcoset::cleanup

mgcoset::cleanup

top mgcoset::init

result = mgcoset::init(elements)

Parameters

elements

top mgcoset__define

mgcoset__define

File attributes

Modification date: Wed May 14 15:07:14 2014
Lines: 94
Docformat: rst rst
Personal library of Michael Galloy
Contact me if you have enhancement requests or bug fixes.