Detail: IndexYearMonth: Method
Overview: IndexYearMonth: Method
- IndexYearMonth.__array__(dtype=None)
Support the __array__ interface, returning an array of values.
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix.__array__() ['1517-04' '1517-12' '1517-06']
- IndexYearMonth.__array_ufunc__(ufunc, method, *args, **kwargs)
Support for NumPy elements or arrays on the left hand of binary operators.
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> np.array((0, 1, 0)) * ix UFuncTypeError(<ufunc 'multiply'>, (dtype('int64'), dtype('<M8[M]')))
- IndexYearMonth.__bool__()
Raises ValueError to prohibit ambiguous use of truthy evaluation.
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> bool(ix) ErrorNotTruthy('The truth value of a container is ambiguous. For a truthy indicator of non-empty status, use the `size` attribute.')
- IndexYearMonth.__copy__()
Return shallow copy of this Index.
>>> import copy >>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> copy.copy(ix) <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]>
- IndexYearMonth.__deepcopy__(memo)
>>> import copy >>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> copy.deepcopy(ix) <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]>
- IndexYearMonth.__len__()
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> len(ix) 3
- IndexYearMonth.all(axis=0, skipna=True, out=None)
Logical
and
over values along the specified axis.- Parameters:
axis – Axis, defaulting to axis 0.
skipna – Skip missing (NaN) values, defaulting to True.
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix.all() True
- IndexYearMonth.any(axis=0, skipna=True, out=None)
Logical
or
over values along the specified axis.- Parameters:
axis – Axis, defaulting to axis 0.
skipna – Skip missing (NaN) values, defaulting to True.
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix.any() True
- IndexYearMonth.astype(dtype)
Return an Index with type determined by dtype argument. If a datetime64 dtype is provided, the appropriate
Index
subclass will be returned. Note that for Index, this is a simple function, whereas forIndexHierarchy
, this is an interface exposing both a callable and a getitem interface.- Parameters:
dtype – A value suitable for specyfying a NumPy dtype, such as a Python type (float), NumPy array protocol strings (‘f8’), or a dtype instance.
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix.astype(str) <Index> 1517-04 1517-12 1517-06 <<U25>
- IndexYearMonth.copy()
Return shallow copy of this Index.
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix.copy() <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]>
- IndexYearMonth.cumprod(axis=0, skipna=True)
Return the cumulative product over the specified axis.
- Parameters:
axis – Axis, defaulting to axis 0.
skipna – Skip missing (NaN) values, defaulting to True.
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix.cumprod() UFuncTypeError(<ufunc 'multiply'>, (dtype('<M8[M]'), dtype('<M8[M]')))
- IndexYearMonth.cumsum(axis=0, skipna=True)
Return the cumulative sum over the specified axis.
- Parameters:
axis – Axis, defaulting to axis 0.
skipna – Skip missing (NaN) values, defaulting to True.
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix.cumsum() UFuncTypeError(<ufunc 'add'>, (dtype('<M8[M]'), dtype('<M8[M]')))
- IndexYearMonth.difference(*others)
Perform difference with another Index, container, or NumPy array. Retains order.
>>> ix1 = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix1 <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix2 = sf.IndexYearMonth(('2022-04', '2021-12', '2022-06')) >>> ix2 <IndexYearMonth> 2022-04 2021-12 2022-06 <datetime64[M]> >>> ix1.difference(ix2) <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]>
- IndexYearMonth.dropfalsy()
Return a new
Index
after removing values of NaN or None.>>> ix = sf.IndexYearMonth(('1620-09', 'NaT', '1620-11')) >>> ix <IndexYearMonth> 1620-09 NaT 1620-11 <datetime64[M]> >>> ix.dropfalsy() <IndexYearMonth> 1620-09 1620-11 <datetime64[M]>
- IndexYearMonth.dropna()
Return a new
Index
after removing values of NaN or None.>>> ix = sf.IndexYearMonth(('1620-09', 'NaT', '1620-11')) >>> ix <IndexYearMonth> 1620-09 NaT 1620-11 <datetime64[M]> >>> ix.dropna() <IndexYearMonth> 1620-09 1620-11 <datetime64[M]>
- IndexYearMonth.equals(other, *, compare_name=False, compare_dtype=False, compare_class=False, skipna=True)
Return a
bool
from comparison to any other object.- Parameters:
compare_name – Include equality of the container’s name (and all composed containers) in the comparison.
compare_dtype – Include equality of the container’s dtype (and all composed containers) in the comparison.
compare_class – Include equality of the container’s class (and all composed containers) in the comparison.
skipna – If True, comparisons between missing values are equal.
>>> ix1 = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix1 <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix2 = sf.IndexYearMonth(('2022-04', '2021-12', '2022-06')) >>> ix2 <IndexYearMonth> 2022-04 2021-12 2022-06 <datetime64[M]> >>> ix1.equals(ix2) False
- IndexYearMonth.fillfalsy(value)
Return an
Index
with replacing falsy values with the supplied value.- Parameters:
value – Value to be used to replace missing values (NaN or None).
>>> ix = sf.IndexYearMonth(('1620-09', 'NaT', '1620-11')) >>> ix <IndexYearMonth> 1620-09 NaT 1620-11 <datetime64[M]> >>> ix.fillfalsy('A') ValueError('Error parsing datetime string "A" at position 0')
- IndexYearMonth.fillna(value)
Return an
Index
with replacing null (NaN or None) with the supplied value.- Parameters:
value – Value to be used to replace missing values (NaN or None).
>>> ix = sf.IndexYearMonth(('1620-09', 'NaT', '1620-11')) >>> ix <IndexYearMonth> 1620-09 NaT 1620-11 <datetime64[M]> >>> ix.fillna(0) <IndexYearMonth> 1620-09 1970-01 1620-11 <datetime64[M]>
- IndexYearMonth.head(count=5)
Return a
Index
consisting only of the top elements as specified bycount
.- Parameters:
count – Number of elements to be returned from the top of the
Index
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix.head(2) <IndexYearMonth> 1517-04 1517-12 <datetime64[M]>
- IndexYearMonth.iloc_searchsorted(values, *, side_left=True)
Given a sorted
Series
, return the iloc (integer) position(s) at which insertion invalues
would retain sort order.- Parameters:
values – a single value, or iterable of values.
side_left – If True, the index of the first suitable location found is given, else return the last such index. If matching an existing value, side_left==True will return that position, side_left==Right will return the next position (or the length).
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix.iloc_searchsorted('c') ValueError('Error parsing datetime string "c" at position 0')
- IndexYearMonth.intersection(*others)
Perform intersection with one or many Index, container, or NumPy array. Identical comparisons retain order.
>>> ix1 = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix1 <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix2 = sf.IndexYearMonth(('2022-04', '2021-12', '2022-06')) >>> ix2 <IndexYearMonth> 2022-04 2021-12 2022-06 <datetime64[M]> >>> ix1.intersection(ix2) <IndexYearMonth> <datetime64[M]>
- IndexYearMonth.isfalsy()
Return a same-shaped, Boolean
ndarray
indicating which values are falsy.>>> ix = sf.IndexYearMonth(('1620-09', 'NaT', '1620-11')) >>> ix.isfalsy() [False True False]
- IndexYearMonth.isin(other)
Return a Boolean array showing True where a label is found in other. If other is a multidimensional array, it is flattened.
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix.isin(('1517-06',)) [False False False]
- IndexYearMonth.isna()
Return a same-shaped, Boolean
ndarray
indicating which values are NaN or None.>>> ix = sf.IndexYearMonth(('1620-09', 'NaT', '1620-11')) >>> ix.isna() [False True False]
- IndexYearMonth.label_widths_at_depth(depth_level=0)
A generator of pairs, where each pair is the label and the contiguous count of that label found at the depth specified by
depth_level
.- Parameters:
depth_level – a depth level, starting from zero.
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> tuple(ix.label_widths_at_depth(0)) ((numpy.datetime64('1517-04'), 1), (numpy.datetime64('1517-12'), 1), (numpy.datetime64('1517-06'), 1))
- IndexYearMonth.level_add(level, *, index_constructor=None)
Return an IndexHierarchy with an added root level.
- Parameters:
level – A hashable to used as the new root.
* –
index_constructor –
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix.level_add('A') <IndexHierarchy> A 1517-04 A 1517-12 A 1517-06 <<U1> <datetime64[M]>
- IndexYearMonth.loc_searchsorted(values, *, side_left=True, fill_value=nan)
Given a sorted
Series
, return the loc (label) position(s) at which insertion invalues
would retain sort order.- Parameters:
values – a single value, or iterable of values.
side_left – If True, the index of the first suitable location found is given, else return the last such index. If matching an existing value, side_left==True will return that position, side_left==Right will return the next position (or the length).
fill_value – A value to be used to fill the label beyond the last label.
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix.loc_searchsorted('c') ValueError('Error parsing datetime string "c" at position 0')
- IndexYearMonth.loc_to_iloc(key)
Given a label (loc) style key (either a label, a list of labels, a slice, or a Boolean selection), return the index position (iloc) style key. Keys that are not found will raise a KeyError or a sf.LocInvalid error.
- Parameters:
key – a label key.
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix.loc_to_iloc('d') ValueError('Error parsing datetime string "d" at position 0') >>> ix.loc_to_iloc(['a', 'e']) ValueError('Cannot create a NumPy datetime other than NaT with generic units') >>> ix.loc_to_iloc(slice('c', None)) ValueError('Error parsing datetime string "c" at position 0')
- IndexYearMonth.max(axis=0, skipna=True, out=None)
Return the maximum along the specified axis.
- Parameters:
axis – Axis, defaulting to axis 0.
skipna – Skip missing (NaN) values, defaulting to True.
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix.max() 1517-12
- IndexYearMonth.mean(axis=0, skipna=True, out=None)
Return the mean along the specified axis.
- Parameters:
axis – Axis, defaulting to axis 0.
skipna – Skip missing (NaN) values, defaulting to True.
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix.mean() UFuncTypeError(<ufunc 'add'>, (dtype('<M8[M]'), dtype('<M8[M]')))
- IndexYearMonth.median(axis=0, skipna=True, out=None)
Return the median along the specified axis.
- Parameters:
axis – Axis, defaulting to axis 0.
skipna – Skip missing (NaN) values, defaulting to True.
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix.median() UFuncTypeError(<ufunc 'add'>, (dtype('<M8[M]'), dtype('<M8[M]')))
- IndexYearMonth.min(axis=0, skipna=True, out=None)
Return the minimum along the specified axis.
- Parameters:
axis – Axis, defaulting to axis 0.
skipna – Skip missing (NaN) values, defaulting to True.
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix.min() 1517-04
- IndexYearMonth.notfalsy()
Return a same-shaped, Boolean
ndarray
indicating which values are falsy.>>> ix = sf.IndexYearMonth(('1620-09', 'NaT', '1620-11')) >>> ix.notfalsy() [ True False True]
- IndexYearMonth.notna()
Return a same-shaped, Boolean
ndarray
indicating which values are NaN or None.>>> ix = sf.IndexYearMonth(('1620-09', 'NaT', '1620-11')) >>> ix.notna() [ True False True]
- IndexYearMonth.prod(axis=0, skipna=True, allna=1, out=None)
Return the product along the specified axis.
- Parameters:
axis – Axis, defaulting to axis 0.
skipna – Skip missing (NaN) values, defaulting to True.
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix.prod() UFuncTypeError(<ufunc 'multiply'>, (dtype('<M8[M]'), dtype('<M8[M]')))
- IndexYearMonth.relabel(mapper)
Return a new Index with labels replaced by the callable or mapping; order will be retained. If a mapping is used, the mapping need not map all origin keys.
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix.relabel(lambda l: l.astype('<M8[ms]').astype(object).day) InvalidDatetime64Initializer('Attempting to create datetime64[M] from an integer, which is generally not desired as the result will be an offset from the epoch.')
- IndexYearMonth.rename(name)
Return a new Frame with an updated name attribute.
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix.rename('y') <IndexYearMonth: y> 1517-04 1517-12 1517-06 <datetime64[M]>
- IndexYearMonth.roll(shift)
Return an Index with values rotated forward and wrapped around (with a postive shift) or backward and wrapped around (with a negative shift).
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix.roll(2) <IndexYearMonth> 1517-12 1517-06 1517-04 <datetime64[M]>
- IndexYearMonth.sample(count=1, *, seed=None)
Randomly (optionally made deterministic with a fixed seed) extract items from the container to return a subset of the container.
- Parameters:
select. (Number of elements to) –
selection. (Initial state of random) –
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix.sample(2, seed=0) <IndexYearMonth> 1517-12 1517-06 <datetime64[M]>
- IndexYearMonth.sort(ascending=True, kind='mergesort', key=None)
Return a new Index with the labels sorted.
- Parameters:
ascending – If True, sort in ascending order; if False, sort in descending order.
kind – Name of the sort algorithm as passed to NumPy.
key – A function that is used to pre-process the selected columns or rows and derive new values to sort by.
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix.sort() <IndexYearMonth> 1517-04 1517-06 1517-12 <datetime64[M]> >>> ix.sort(ascending=False) <IndexYearMonth> 1517-12 1517-06 1517-04 <datetime64[M]>
- IndexYearMonth.std(axis=0, skipna=True, ddof=0, out=None)
Return the standard deviaton along the specified axis.
- Parameters:
axis – Axis, defaulting to axis 0.
skipna – Skip missing (NaN) values, defaulting to True.
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix.std() UFuncTypeError(<ufunc 'add'>, (dtype('<M8[M]'), dtype('<M8[M]')))
- IndexYearMonth.sum(axis=0, skipna=True, allna=0, out=None)
Sum values along the specified axis.
- Parameters:
axis – Axis, defaulting to axis 0.
skipna – Skip missing (NaN) values, defaulting to True.
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix.sum() UFuncTypeError(<ufunc 'add'>, (dtype('<M8[M]'), dtype('<M8[M]')))
- IndexYearMonth.tail(count=5)
Return a
Index
consisting only of the bottom elements as specified bycount
.- Parameters:
count – Number of elements to be returned from the bottom of the
Index
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix.tail(2) <IndexYearMonth> 1517-12 1517-06 <datetime64[M]>
- IndexYearMonth.union(*others)
Perform union with another Index, container, or NumPy array. Identical comparisons retain order.
>>> ix1 = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix1 <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix2 = sf.IndexYearMonth(('2022-04', '2021-12', '2022-06')) >>> ix2 <IndexYearMonth> 2022-04 2021-12 2022-06 <datetime64[M]> >>> ix1.union(ix2) <IndexYearMonth> 1517-04 1517-06 1517-12 2021-12 2022-04 2022-06 <datetime64[M]>
- IndexYearMonth.unique(depth_level=0, order_by_occurrence=False)
Return a NumPy array of unique values.
- Parameters:
depth_level – defaults to 0 for for a 1D Index.
order_by_occurrence – for 1D indices, this argument is a no-op. Provided for compatibility with IndexHierarchy.
- Returns:
numpy.ndarray
>>> ix = sf.IndexYearMonth(('1620-09', 'NaT', '1620-11')) >>> ix <IndexYearMonth> 1620-09 NaT 1620-11 <datetime64[M]> >>> ix.unique() ['1620-09' 'NaT' '1620-11']
- IndexYearMonth.values_at_depth(depth_level=0)
Return an NP array for the depth_level specified.
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix.values_at_depth(0) ['1517-04' '1517-12' '1517-06']
- IndexYearMonth.var(axis=0, skipna=True, ddof=0, out=None)
Return the variance along the specified axis.
- Parameters:
axis – Axis, defaulting to axis 0.
skipna – Skip missing (NaN) values, defaulting to True.
>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06')) >>> ix <IndexYearMonth> 1517-04 1517-12 1517-06 <datetime64[M]> >>> ix.var() UFuncTypeError(<ufunc 'add'>, (dtype('<M8[M]'), dtype('<M8[M]')))
IndexYearMonth: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary | Operator Unary | Accessor Values | Accessor Datetime | Accessor String | Accessor Regular Expression | Accessor Hashlib | Accessor Type Clinic