lib/
gpuvariable__define.pro
Represents a GPU variable.
Class description for gpuvariable
Inheritance
Subclasses: gpuvariableview
Properties
- n_elements get type=long
total number of elements in the variable
- DOUBLE init
- _handle get
- DCOMPLEX init
- n_dimensions get type=long
number of dimensions: 0, 1, 2
- _data get
- INDEX init
- COMPLEX init
- value init type=scalar numeric
scalar to fill in the array with
- dimensions get init type=lonarr(2)
size of each dimension
- views get
- ERROR init
- _is_temporary get
- type get init type=long
IDL type code for variable
- FLOAT init
- TEMPORARY init
- NOZERO init
Routines
result = gpuvariable::_overloadPlus(left, right)Handle adding GPU variables.
result = gpuvariable::_overloadMinus(left, right)Handle subtracting GPU variables.
result = gpuvariable::_overloadAsterisk(left, right)Handle multiplying GPU variables.
result = gpuvariable::_overloadSlash(left, right)Handle dividing GPU variables.
result = gpuvariable::_overloadMOD(left, right)Handle MOD for GPU variables.
result = gpuvariable::_overloadCaret(left, right)Handle raising GPU variables to powers.
result = gpuvariable::_overloadPound(left, right)Handle matrix multiplication with GPU variables.
result = gpuvariable::_overloadPoundPound(left, right)Handle matrix multiplication with GPU variables.
result = gpuvariable::_overloadLT(left, right)Handle LT operator for GPU variables.
result = gpuvariable::_overloadLE(left, right)Handle LE operator for GPU variables.
result = gpuvariable::_overloadGT(left, right)Handle GT operator for GPU variables.
result = gpuvariable::_overloadGE(left, right)Handle GE operator for GPU variables.
result = gpuvariable::_overloadEQ(left, right)Handle EQ operator for GPU variables.
result = gpuvariable::_overloadNE(left, right)Handle NE operator for GPU variables.
result = gpuvariable::_overloadMinusUnary()Handle unary - operator for GPU variables.
result = gpuvariable::_overloadLessThan(left, right)Handle < operator for GPU variables.
result = gpuvariable::_overloadGreaterThan(left, right)Handle > operator for GPU variables.
gpuvariable::_overloadBracketsLeftSide, objref, value, isRange, ss1, ss2, ss3, ss4, ss5, ss6, ss7, ss8Handle assignment to slices of GPU variables.
result = gpuvariable::_overloadBracketsRightSide(isRange, ss1, ss2, ss3, ss4, ss5, ss6, ss7, ss8)Handle indexing GPU variables.
result = gpuvariable::_overloadForeach(value, key)Handle GPU variables in FOREACH statements.
result = gpuvariable::_overloadHelp(varname)Overload output for HELP routine.
result = gpuvariable::_overloadPrint()Overload output for PRINT routine.
result = gpuvariable::_overloadSize()Overload output for SIZE routine.
gpuvariable::getProperty, type=long, n_elements=long, n_dimensions=long, dimensions=lonarr(2), views=views, _is_temporary=_is_temporary, _handle=_handle, _data=_dataGet properties of the variable.
result = gpuvariable::getType()gpuvariable::_setType, typeresult = gpuvariable::getNElements()gpuvariable::_setNElements, n_elementsresult = gpuvariable::getNDimensions()gpuvariable::_setNDimensions, n_dimensionsresult = gpuvariable::getDimensions()gpuvariable::_setDimensions, dimensionsresult = gpuvariable::getType()result = gpuvariable::_getData()gpuvariable::_setData, data, XOFFSET=XOFFSET, XWIDTH=XWIDTH, YOFFSET=YOFFSET, YWIDTH=YWIDTH, INDICES=INDICESresult = gpuvariable::_getHandle()gpuvariable::_setHandle, handleresult = gpuvariable::_getParent()result = gpuvariable::_isTemporary()gpuvariable::_setTemporary, temporarygpuvariable::putarr, value, ERROR=ERROR, CPU=CPU, STREAM=STREAMresult = gpuvariable::getarr(LHS=LHS, ERROR=ERROR, CPU=CPU, STREAM=STREAM)result = gpuvariable::_createView(offset, nelements)Create a view of this GPU variable.
gpuvariable::_allocate, INDEX=INDEX, NOZERO=NOZERO, VALUE=VALUE, ERROR=ERRORAllocate the variable on the GPU (or in heap memory if using pure IDL emulation).
gpuvariable::_freegpuvariable::cleanupFree GPU variable resources.
result = gpuvariable::init(TYPE=long, DIMENSIONS=lonarr(2), FLOAT=FLOAT, DOUBLE=DOUBLE, COMPLEX=COMPLEX, DCOMPLEX=DCOMPLEX, INDEX=INDEX, NOZERO=NOZERO, VALUE=scalar numeric, ERROR=ERROR, TEMPORARY=TEMPORARY)Create a GPUVariable object.
gpuvariable__defineDefine GPU variable's fields.
Routine details
top gpuvariable::_overloadPlus
result = gpuvariable::_overloadPlus(left, right)
Handle adding GPU variables.
Return value
GPU variable object
Parameters
- left in required type=GPUVariable object or numeric array
left side of + operator
- right in required type=GPUVariable object or numeric array
right side of + operator
top gpuvariable::_overloadMinus
result = gpuvariable::_overloadMinus(left, right)
Handle subtracting GPU variables.
Return value
GPU variable object
Parameters
- left in required type=GPUVariable object or numeric array
left side of - operator
- right in required type=GPUVariable object or numeric array
right side of - operator
top gpuvariable::_overloadAsterisk
result = gpuvariable::_overloadAsterisk(left, right)
Handle multiplying GPU variables.
Return value
GPU variable object
Parameters
- left in required type=GPUVariable object or numeric array
left side of * operator
- right in required type=GPUVariable object or numeric array
right side of * operator
top gpuvariable::_overloadSlash
result = gpuvariable::_overloadSlash(left, right)
Handle dividing GPU variables.
Return value
GPU variable object
Parameters
- left in required type=GPUVariable object or numeric array
left side of / operator
- right in required type=GPUVariable object or numeric array
right side of / operator
top gpuvariable::_overloadMOD
result = gpuvariable::_overloadMOD(left, right)
Handle MOD for GPU variables.
Return value
GPU variable object
Parameters
- left in required type=GPUVariable object or numeric array
left side of MOD operator
- right in required type=GPUVariable object or numeric array
right side of MOD operator
top gpuvariable::_overloadCaret
result = gpuvariable::_overloadCaret(left, right)
Handle raising GPU variables to powers.
Return value
GPU variable object
Parameters
- left in required type=GPUVariable object or numeric array
left side of ^ operator
- right in required type=GPUVariable object or numeric array
right side of ^ operator
top gpuvariable::_overloadPound
result = gpuvariable::_overloadPound(left, right)
Handle matrix multiplication with GPU variables.
Return value
GPU variable object
Parameters
- left in required type=GPUVariable object or numeric array
left side of # operator
- right in required type=GPUVariable object or numeric array
right side of # operator
top gpuvariable::_overloadPoundPound
result = gpuvariable::_overloadPoundPound(left, right)
Handle matrix multiplication with GPU variables.
Return value
GPU variable object
Parameters
- left in required type=GPUVariable object or numeric array
left side of ## operator
- right in required type=GPUVariable object or numeric array
right side of ## operator
top gpuvariable::_overloadLT
result = gpuvariable::_overloadLT(left, right)
Handle LT operator for GPU variables.
Return value
GPU variable object
Parameters
- left in required type=GPUVariable object or numeric array
left side of LT operator
- right in required type=GPUVariable object or numeric array
right side of LT operator
top gpuvariable::_overloadLE
result = gpuvariable::_overloadLE(left, right)
Handle LE operator for GPU variables.
Return value
GPU variable object
Parameters
- left in required type=GPUVariable object or numeric array
left side of LE operator
- right in required type=GPUVariable object or numeric array
right side of LE operator
top gpuvariable::_overloadGT
result = gpuvariable::_overloadGT(left, right)
Handle GT operator for GPU variables.
Return value
GPU variable object
Parameters
- left in required type=GPUVariable object or numeric array
left side of GT operator
- right in required type=GPUVariable object or numeric array
right side of GT operator
top gpuvariable::_overloadGE
result = gpuvariable::_overloadGE(left, right)
Handle GE operator for GPU variables.
Return value
GPU variable object
Parameters
- left in required type=GPUVariable object or numeric array
left side of GE operator
- right in required type=GPUVariable object or numeric array
right side of GE operator
top gpuvariable::_overloadEQ
result = gpuvariable::_overloadEQ(left, right)
Handle EQ operator for GPU variables.
Return value
GPU variable object
Parameters
- left in required type=GPUVariable object or numeric array
left side of EQ operator
- right in required type=GPUVariable object or numeric array
right side of EQ operator
top gpuvariable::_overloadNE
result = gpuvariable::_overloadNE(left, right)
Handle NE operator for GPU variables.
Return value
GPU variable object
Parameters
- left in required type=GPUVariable object or numeric array
left side of NE operator
- right in required type=GPUVariable object or numeric array
right side of NE operator
top gpuvariable::_overloadMinusUnary
result = gpuvariable::_overloadMinusUnary()
Handle unary - operator for GPU variables.
Return value
GPU variable object
top gpuvariable::_overloadLessThan
result = gpuvariable::_overloadLessThan(left, right)
Handle < operator for GPU variables.
Return value
GPU variable object
Parameters
- left in required type=GPUVariable object or numeric array
left side of < operator
- right in required type=GPUVariable object or numeric array
right side of < operator
top gpuvariable::_overloadGreaterThan
result = gpuvariable::_overloadGreaterThan(left, right)
Handle > operator for GPU variables.
Return value
GPU variable object
Parameters
- left in required type=GPUVariable object or numeric array
left side of > operator
- right in required type=GPUVariable object or numeric array
right side of > operator
top gpuvariable::_overloadBracketsLeftSide
gpuvariable::_overloadBracketsLeftSide, objref, value, isRange, ss1, ss2, ss3, ss4, ss5, ss6, ss7, ss8
Handle assignment to slices of GPU variables.
Parameters
- objref
- value
- isRange
- ss1
- ss2
- ss3
- ss4
- ss5
- ss6
- ss7
- ss8
top gpuvariable::_overloadBracketsRightSide
result = gpuvariable::_overloadBracketsRightSide(isRange, ss1, ss2, ss3, ss4, ss5, ss6, ss7, ss8)
Handle indexing GPU variables.
Return value
GPU variable object
Parameters
- isRange
- ss1
- ss2
- ss3
- ss4
- ss5
- ss6
- ss7
- ss8
top gpuvariable::_overloadForeach
result = gpuvariable::_overloadForeach(value, key)
Handle GPU variables in FOREACH statements. For 1-dimensional arrays, each iteration will yield a view of a single element array. For 2-dimensional arrays, each iteration will yield a view of a row of the array. The key for each is a long integer index, either the element index in the 1-dimensional case or the row index in the 2-dimensional case.
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 gpuvariable::_overloadHelp
result = gpuvariable::_overloadHelp(varname)
Overload output for HELP routine.
Parameters
- varname in required type=string
variable name
top gpuvariable::_overloadPrint
result = gpuvariable::_overloadPrint()
Overload output for PRINT routine.
top gpuvariable::_overloadSize
result = gpuvariable::_overloadSize()
Overload output for SIZE routine.
top gpuvariable::getProperty
gpuvariable::getProperty, type=long, n_elements=long, n_dimensions=long, dimensions=lonarr(2), views=views, _is_temporary=_is_temporary, _handle=_handle, _data=_data
Get properties of the variable.
Keywords
- type type=long
IDL type code for variable
- n_elements type=long
total number of elements in the variable
- n_dimensions type=long
number of dimensions: 0, 1, 2
- dimensions type=lonarr(2)
size of each dimension
- views
- _is_temporary
- _handle
- _data
top gpuvariable::getType
result = gpuvariable::getType()
top gpuvariable::getNElements
result = gpuvariable::getNElements()
top gpuvariable::getNDimensions
result = gpuvariable::getNDimensions()
top gpuvariable::getDimensions
result = gpuvariable::getDimensions()
top gpuvariable::getType
result = gpuvariable::getType()
top gpuvariable::_getData
result = gpuvariable::_getData()
top gpuvariable::_setData
gpuvariable::_setData, data, XOFFSET=XOFFSET, XWIDTH=XWIDTH, YOFFSET=YOFFSET, YWIDTH=YWIDTH, INDICES=INDICES
Parameters
- data
Keywords
- XOFFSET
- XWIDTH
- YOFFSET
- YWIDTH
- INDICES
top gpuvariable::_getHandle
result = gpuvariable::_getHandle()
top gpuvariable::_getParent
result = gpuvariable::_getParent()
top gpuvariable::_isTemporary
result = gpuvariable::_isTemporary()
top gpuvariable::putarr
gpuvariable::putarr, value, ERROR=ERROR, CPU=CPU, STREAM=STREAM
Parameters
- value
Keywords
- ERROR
- CPU
- STREAM
top gpuvariable::getarr
result = gpuvariable::getarr(LHS=LHS, ERROR=ERROR, CPU=CPU, STREAM=STREAM)
Keywords
- LHS
- ERROR
- CPU
- STREAM
top gpuvariable::_createView
result = gpuvariable::_createView(offset, nelements)
Create a view of this GPU variable.
Return value
GPU variable view
Parameters
- offset in required type=long
array element of origin of view
- nelements in required type=long
number of elements in the view
top gpuvariable::_allocate
gpuvariable::_allocate, INDEX=INDEX, NOZERO=NOZERO, VALUE=VALUE, ERROR=ERROR
Allocate the variable on the GPU (or in heap memory if using pure IDL emulation).
Keywords
- INDEX
- NOZERO
- VALUE
- ERROR
top gpuvariable::_free
gpuvariable::_free
top gpuvariable::init
result = gpuvariable::init(TYPE=long, DIMENSIONS=lonarr(2), FLOAT=FLOAT, DOUBLE=DOUBLE, COMPLEX=COMPLEX, DCOMPLEX=DCOMPLEX, INDEX=INDEX, NOZERO=NOZERO, VALUE=scalar numeric, ERROR=ERROR, TEMPORARY=TEMPORARY)
Create a GPUVariable object.
Return value
1 if successfully initialized, 0 if not
Keywords
- TYPE type=long
IDL type code for variable
- DIMENSIONS type=lonarr(2)
size of each dimension
- FLOAT
- DOUBLE
- COMPLEX
- DCOMPLEX
- INDEX
- NOZERO
- VALUE type=scalar numeric
scalar to fill in the array with
- ERROR
- TEMPORARY
File attributes
| Modification date: | Fri Nov 12 11:07:44 2010 |
| Lines: | 986 |
| Docformat: | rst rst |