|
This
documentation is of interest only to the programmer
working in the C Language and should really be in
the Programming Manual. This a temporary
location.
The
AtomVect module provides one function in its C
API.
|
Function
Name
|
Return
Type
|
Return
Value
|
|
isAtomVector
|
int
|
whether
#1
is an Atom Vector
|
|
Argument
|
Type
|
Value
|
|
#1
|
PyObject
*
|
the
subject of this query; must not be
NULL!
|
|
#2
|
PyObject
**
|
the
root Atom Map (possibly NULL) is returned
here
|
|
#3
|
double
**
|
returns
a pointer to the atom vector
buffer
|
|
#4
|
int
*
|
the
number of atoms is returned
here
|
|
#5
|
int
*
|
the
number of dimensions is returned
here
|
|
Return
Value
|
Indicate
|
|
0
|
#1
is not an Atom Vector
|
|
1
|
#1
is an Atom Vector
|
The
root Atom Map returned in
#2
is a NULL pointer if #1
is an Anonymous Atom Vector. If you keep a non-NULL
pointer to the root Atom Map, be sure to update the
reference counter for the map. The pointer returned
in #3
references the actual location of the atom vector
array. Do not deallocate this storage
area.
|