Version 1.0b1 API Documentation generated by Endo 2006-08-14

Variables

• array_precision

  array_precision = { Getattr(Name('_nx'), 'single') : Const(0), Getattr(Name('_nx'), 'double') : Const(1), Getattr(Name('_nx'), 'longdouble') : Const(2), Getattr(Name('_nx'), 'csingle') : Const(0), Getattr(Name('_nx'), 'cdouble') : Const(1), Getattr(Name('_nx'), 'clongdouble') : Const(2) }
  
  

• array_type

  determine the "minimum common type" for a group of arrays.

  array_type = [ [ _nx.single, _nx.double, _nx.longdouble ], [ _nx.csingle, _nx.cdouble, _nx.clongdouble ] ]
  
  

Function summary

• asfarray(a, dtype = _nx.float_)
• asscalar(a)
• common_type(arrays)
• imag(val)
• iscomplex(x)
• iscomplexobj(x)
• isreal(x)
• isrealobj(x)
• mintypecode(typechars, typeset = 'GDFgdf', default = 'd')
• nan_to_num(x)
• real(val)
• real_if_close(a, tol = 100)
• typename(char)

Functions

• asfarray(a, dtype = _nx.float_)

  asfarray(a,dtype=None) returns a as a float array.

• asscalar(a)

  Convert an array of size 1 to its scalar equivalent.

• common_type(arrays)

  Given a sequence of arrays as arguments, return the best inexact scalar type which is "most" common amongst them.

  The return type will always be a inexact scalar type, even if all the arrays are integer arrays.

• imag(val)

  Return the imaginary part of val.

  Useful if val maybe a scalar or an array.

• iscomplex(x)

  Return a boolean array where elements are True if that element is complex (has non-zero imaginary part).

  For scalars, return a boolean.

• iscomplexobj(x)

  Return True if x is a complex type or an array of complex numbers.

  Unlike iscomplex(x), complex(3.0) is considered a complex object.

• isreal(x)

  Return a boolean array where elements are True if that element is real (has zero imaginary part)

  For scalars, return a boolean.

• isrealobj(x)

  Return True if x is not a complex type.

  Unlike isreal(x), complex(3.0) is considered a complex object.

• mintypecode(typechars, typeset = 'GDFgdf', default = 'd')

  Return a minimum data type character from typeset that handles all typechars given

  The returned type character must be the smallest size such that an array of the returned type can handle the data from an array of type t for each t in typechars (or if typechars is an array, then its dtype.char).

  If the typechars does not intersect with the typeset, then default is returned.

  If t in typechars is not a string then t=asarray(t).dtype.char is applied.

• nan_to_num(x)
• real(val)

  Return the real part of val.

  Useful if val maybe a scalar or an array.

• real_if_close(a, tol = 100)

  If a is a complex array, return it as a real array if the imaginary part is close enough to zero.

  "Close enough" is defined as tol*(machine epsilon of a's element type).

• typename(char)

  Return an english description for the given data type character.

Imported names