constantDesc#

swordfish.function.constantDesc()#

This function provides a description of an object.

Parameters:

obj (Constant) – An object.

Returns:

A dictionary with the following keys:

  • form : the data form

  • vectorType : the specific vector type, returns only when obj is a vector

  • isIndexedMatrix : whether it is an indexed matrix, returns only when obj is a matrix

  • isIndexedSeries : whether it is an indexed series, returns only when obj is a matrix

  • nullFlag : whether it contains null values, returns only when obj is a vector, pair, or matrix

  • isView : whether it is a view, returns only when obj is a vector, pair, or matrix

  • tableType : the specific table type, returns only when obj is a table

  • type : the data type

  • codeType : the specific metacode type, returns only when obj is metacode

  • functionDefType : the specific function type, returns only when obj is a function

  • scale : the number of decimal places, returns only when obj is of DECIMAL type

  • isColumnarTuple : whether it is a columnar tuple, returns only when obj is a tuple, excluding any view representations

  • category : the data type category

  • isTemporary : whether it is a temporary object

  • isIndependent : whether it is an independent object

  • isReadonly : whether it is a read-only object

  • isReadonlyArgument : whether it is a read-only argument

  • isStatic : whether it is a static object

  • isTransient : whether it is a transient object

  • copyOnWrite : whether it employs copy-on-write behavior

  • refCount : the count that has been referenced

  • address : the hexadecimal address

  • rows : the row count

  • columns : the column count

  • memoryAllocated : the memory allocated

Return type:

Constant

On this page