Detail: IndexHierarchyGO: Attribute#

IndexHierarchyGO.STATIC = False#

>>> ih = sf.IndexHierarchyGO.from_labels((('a', 1024, '1517-04-01'), ('a', 2048, '1789-12-31'), ('b', 0, '1620-11-21')), index_constructors=(sf.Index, sf.Index, sf.IndexDate), name=('x', 'y', 'z'))
>>> ih.STATIC
False

IndexHierarchyGO.depth#

Return the depth of the index hierarchy.

>>> ih = sf.IndexHierarchyGO.from_labels((('a', 1024, '1517-04-01'), ('a', 2048, '1789-12-31'), ('b', 0, '1620-11-21')), index_constructors=(sf.Index, sf.Index, sf.IndexDate), name=('x', 'y', 'z'))
>>> ih.depth
3

IndexHierarchyGO.dtypes#

Return a Series of dytpes for each index depth.

Returns:: static_frame.Series

>>> ih = sf.IndexHierarchyGO.from_labels((('a', 1024, '1517-04-01'), ('a', 2048, '1789-12-31'), ('b', 0, '1620-11-21')), index_constructors=(sf.Index, sf.Index, sf.IndexDate), name=('x', 'y', 'z'))
>>> ih.dtypes
<Series>
<Index>
x        <U1
y        int64
z        datetime64[D]
<<U1>    <object>

IndexHierarchyGO.index_types#

Return a Series of Index classes for each index depth.

Returns:: Series

>>> ih = sf.IndexHierarchyGO.from_labels((('a', 1024, '1517-04-01'), ('a', 2048, '1789-12-31'), ('b', 0, '1620-11-21')), index_constructors=(sf.Index, sf.Index, sf.IndexDate), name=('x', 'y', 'z'))
>>> ih.index_types
<Series>
<Index>
x        <IndexGO>
y        <IndexGO>
z        <IndexDateGO>
<<U1>    <object>

IndexHierarchyGO.memory#

A MemoryDisplay, providing the size in memory of this object. For compound containers, component sizes will also be provided. Size can be interpreted through six combinations of three configurations:

L: Local: memory ignoring referenced array data provided via views. LM: Local Materialized: memory where arrays that are locally owned report their byte payload LMD: Local Materialized Data: locally owned memory of arrays byte payloads, excluding all other components

R: Referenced: memory including referenced array data provided via views RM: Referenced Materialized: memory where arrays that are locally owned or referenced report their byte payload RMD: Referenced Materialized Data: localy owned and referenced array byte payloads, excluding all other components

>>> ih = sf.IndexHierarchyGO.from_labels((('a', 1024, '1517-04-01'), ('a', 2048, '1789-12-31'), ('b', 0, '1620-11-21')), index_constructors=(sf.Index, sf.Index, sf.IndexDate), name=('x', 'y', 'z'))
>>> ih.memory
         L    Lu    LM   LMu   LMD  LMDu  R     Ru    RM   RMu   RMD  RMDu
Name     198  B     198  B     198  B     198   B     198  B     198  B
Indices  3.37 KB    3.46 KB    2.71 KB    11.48 KB    3.53 KB    2.78 KB
Indexers 200  B     200  B     72   B     200   B     200  B     72   B
Blocks   740  B     788  B     404  B     740   B     788  B     404  B
Values   16   B     16   B     16   B     16    B     16   B     16   B
Total    5.31 KB    5.47 KB    4.09 KB    13.42 KB    5.53 KB    4.16 KB

IndexHierarchyGO.mloc#: The memory location, represented as an integer, of the underlying NumPy array.

IndexHierarchyGO.name#

A hashable label attached to this container.

Returns:: Hashable

>>> ih = sf.IndexHierarchyGO.from_labels((('a', 1024, '1517-04-01'), ('a', 2048, '1789-12-31'), ('b', 0, '1620-11-21')), index_constructors=(sf.Index, sf.Index, sf.IndexDate), name=('x', 'y', 'z'))
>>> ih.name
('x', 'y', 'z')

IndexHierarchyGO.names#

Provide a suitable iterable of names for usage in output formats that require a field name as string for the index.

>>> ih = sf.IndexHierarchyGO.from_labels((('a', 1024, '1517-04-01'), ('a', 2048, '1789-12-31'), ('b', 0, '1620-11-21')), index_constructors=(sf.Index, sf.Index, sf.IndexDate), name=('x', 'y', 'z'))
>>> ih.names
('x', 'y', 'z')

IndexHierarchyGO.nbytes#

Return the total bytes of the underlying NumPy array.

Returns:: int

>>> ih = sf.IndexHierarchyGO.from_labels((('a', 1024, '1517-04-01'), ('a', 2048, '1789-12-31'), ('b', 0, '1620-11-21')), index_constructors=(sf.Index, sf.Index, sf.IndexDate), name=('x', 'y', 'z'))
>>> ih.nbytes
741

IndexHierarchyGO.ndim#

Return the number of dimensions.

Returns:: int

>>> ih = sf.IndexHierarchyGO.from_labels((('a', 1024, '1517-04-01'), ('a', 2048, '1789-12-31'), ('b', 0, '1620-11-21')), index_constructors=(sf.Index, sf.Index, sf.IndexDate), name=('x', 'y', 'z'))
>>> ih.ndim
2

IndexHierarchyGO.positions#

Return the immutable positions array.

>>> ih = sf.IndexHierarchyGO.from_labels((('a', 1024, '1517-04-01'), ('a', 2048, '1789-12-31'), ('b', 0, '1620-11-21')), index_constructors=(sf.Index, sf.Index, sf.IndexDate), name=('x', 'y', 'z'))
>>> ih.positions
[0 1 2]

IndexHierarchyGO.shape#

Return a tuple describing the shape of the underlying NumPy array.

Returns:: tp.Tuple[int]

>>> ih = sf.IndexHierarchyGO.from_labels((('a', 1024, '1517-04-01'), ('a', 2048, '1789-12-31'), ('b', 0, '1620-11-21')), index_constructors=(sf.Index, sf.Index, sf.IndexDate), name=('x', 'y', 'z'))
>>> ih.shape
(3, 3)

IndexHierarchyGO.size#

Return the size of the underlying NumPy array.

Returns:: int

>>> ih = sf.IndexHierarchyGO.from_labels((('a', 1024, '1517-04-01'), ('a', 2048, '1789-12-31'), ('b', 0, '1620-11-21')), index_constructors=(sf.Index, sf.Index, sf.IndexDate), name=('x', 'y', 'z'))
>>> ih.size
9