Detail: IndexYear: Attribute¶

IndexYear.STATIC = True¶

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix.STATIC
True

IndexYear.depth = 1¶

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix.depth
1

IndexYear.dtype¶

Return the dtype of the underlying NumPy array.

Returns: numpy.dtype

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix.dtype
datetime64[Y]

IndexYear.index_types¶

Return a Series of Index classes for each index depth.

Returns: Series

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix.index_types
<Series>
<Index>
None     <IndexYear>
<object> <object>

IndexYear.memory¶

Return 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

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix.memory
          L   Lu    LM  LMu   LMD LMDu  R    Ru    RM  RMu   RMD RMDu
Name      16  B     16  B     16  B     16   B     16  B     16  B
Map       440 B     440 B     440 B     440  B     440 B     440 B
Labels    120 B     136 B     24  B     120  B     136 B     24  B
Positions 96  B     112 B     0   B     8.19 KB    136 B     24  B
Total     768 B     800 B     576 B     8.84 KB    824 B     600 B

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

IndexYear.name¶

A hashable label attached to this container.

Returns: Hashable

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix.name

IndexYear.names¶

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

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix.names
('__index0__',)

IndexYear.nbytes¶

Return the total bytes of the underlying NumPy array.

Returns: int

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix.nbytes
24

IndexYear.ndim¶

Return the number of dimensions.

Returns: int

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix.ndim
1

IndexYear.positions¶

Return the immutable positions array.

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix.positions
[0 1 2]

IndexYear.shape¶

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

Returns: tp.Tuple[int]

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix.shape
(3,)

IndexYear.size¶

Return the size of the underlying NumPy array.

Returns: int

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix.size
3