Index

Detail: Index

Index: Constructor

Detail: Index: Constructor

Detail

Index.__init__(labels, *, loc_is_iloc, name, dtype)

Initializer. Args: labels: An iterable of unique, hashable values, or another In…

Detail

Index.from_labels(labels, *, name)

Construct an Index from an iterable of labels, where each label is a hashable. P…

Detail

Index.from_pandas(value)

Given a Pandas index, return the appropriate IndexBase derived class.

Index: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary | Operator Unary | Accessor Datetime | Accessor String

Index: Exporter

Detail: Index: Exporter

Detail

Index.to_html(config)

Return an HTML table representation of this Index using standard TABLE, TR, and…

Detail

Index.to_html_datatables(fp, *, show, config)

Return a complete HTML representation of this Index using the DataTables JS libr…

Detail

Index.to_pandas()

Return a Pandas Index.

Detail

Index.to_series()

Return a Series with values from this Index’s labels.

Index: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary | Operator Unary | Accessor Datetime | Accessor String

Index: Attribute

Detail: Index: Attribute

Detail

Index.STATIC

bool(x) -> bool Returns True when the argument x is true, False otherwise. The b…

Detail

Index.depth

int([x]) -> integer int(x, base=10) -> integer Convert a number or string to an…

Detail

Index.dtype

Return the dtype of the underlying NumPy array. Returns: numpy.dtype

Detail

Index.mloc

The memory location, represented as an integer, of the underlying NumPy array.

Detail

Index.name

A hashable label attached to this container. Returns: Hashable

Detail

Index.names

Provide a suitable iterable of names for usage in output formats that require a…

Detail

Index.nbytes

Return the total bytes of the underlying NumPy array. Returns: int

Detail

Index.ndim

Return the number of dimensions. Returns: int

Detail

Index.positions

Return the immutable positions array.

Detail

Index.shape

Return a tuple describing the shape of the underlying NumPy array. Returns: tp.T…

Detail

Index.size

Return the size of the underlying NumPy array. Returns: int

Index: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary | Operator Unary | Accessor Datetime | Accessor String

Index: Method

Detail: Index: Method

Detail

Index.__bool__()

Raises ValueError to prohibit ambiguous use of truethy evaluation.

Detail

Index.__copy__()

Return shallow copy of this Index.

Detail

Index.__deepcopy__(memo)

Detail

Index.__len__()

Detail

Index.all(axis, skipna, out)

Logical and over values along the specified axis. Args: axis: Axis, defaulting t…

Detail

Index.any(axis, skipna, out)

Logical or over values along the specified axis. Args: axis: Axis, defaulting to…

Detail

Index.astype(dtype)

Return an Index with type determined by dtype argument. Note that for Index, thi…

Detail

Index.copy()

Return shallow copy of this Index.

Detail

Index.cumprod(axis, skipna)

Return the cumulative product over the specified axis. Args: axis: Axis, default…

Detail

Index.cumsum(axis, skipna)

Return the cumulative sum over the specified axis. Args: axis: Axis, defaulting…

Detail

Index.difference(other)

Perform difference with another Index, container, or NumPy array. Retains order.

Detail

Index.equals(other, *, compare_name, compare_dtype, compare_class, skipna)

Return a bool from comparison to any other object. Args: compare_name: Include e…

Detail

Index.fillna(value)

Return an Index with replacing null (NaN or None) with the supplied value. Args:…

Detail

Index.head(count)

Return a Index consisting only of the top elements as specified by count. Args:…

Detail

Index.iloc_searchsorted(values, *, side_left)

Given a sorted Series, return the iloc (integer) position(s) at which insertion…

Detail

Index.intersection(*others)

Perform intersection with one or many Index, container, or NumPy array. Identica…

Detail

Index.isin(other)

Return a Boolean array showing True where a label is found in other. If other is…

Detail

Index.label_widths_at_depth(depth_level)

A generator of pairs, where each pair is the label and the count of that label f…

Detail

Index.level_add(level)

Return an IndexHierarchy with an added root level.

Detail

Index.loc_searchsorted(values, *, side_left, fill_value)

Given a sorted Series, return the loc (label) position(s) at which insertion in…

Detail

Index.loc_to_iloc(key)

Given a label (loc) style key (either a label, a list of labels, a slice, or a B…

Detail

Index.max(axis, skipna)

Return the maximum along the specified axis. Args: axis: Axis, defaulting to axi…

Detail

Index.mean(axis, skipna, out)

Return the mean along the specified axis. Args: axis: Axis, defaulting to axis 0…

Detail

Index.median(axis, skipna, out)

Return the median along the specified axis. Args: axis: Axis, defaulting to axis…

Detail

Index.min(axis, skipna, out)

Return the minimum along the specified axis. Args: axis: Axis, defaulting to axi…

Detail

Index.prod(axis, skipna, out)

Return the product along the specified axis. Args: axis: Axis, defaulting to axi…

Detail

Index.relabel(mapper)

Return a new Index with labels replaced by the callable or mapping; order will b…

Detail

Index.rename(name)

Return a new Frame with an updated name attribute.

Detail

Index.roll(shift)

Return an Index with values rotated forward and wrapped around (with a postive s…

Detail

Index.sample(count, *, seed)

Randomly (optionally made deterministic with a fixed seed) extract items from th…

Detail

Index.sort(ascending, kind, key)

Return a new Index with the labels sorted. Args: ascending: If True, sort in asc…

Detail

Index.std(axis, skipna, ddof, out)

Return the standard deviaton along the specified axis. Args: axis: Axis, default…

Detail

Index.sum(axis, skipna, out)

Sum values along the specified axis. Args: axis: Axis, defaulting to axis 0. ski…

Detail

Index.tail(count)

Return a Index consisting only of the bottom elements as specified by count. Arg…

Detail

Index.union(*others)

Perform union with another Index, container, or NumPy array. Identical compariso…

Detail

Index.unique(depth_level)

Return a NumPy array of unique values. Args: depth_level: defaults to 0 for for…

Detail

Index.values_at_depth(depth_level)

Return an NP array for the depth_level specified.

Detail

Index.var(axis, skipna, ddof, out)

Return the variance along the specified axis. Args: axis: Axis, defaulting to ax…

Index: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary | Operator Unary | Accessor Datetime | Accessor String

Index: Dictionary-Like

Detail: Index: Dictionary-Like

Detail

Index.__contains__(value)

Return True if value in the labels.

Detail

Index.__iter__()

Iterate over labels.

Detail

Index.__reversed__()

Returns a reverse iterator on the index labels.

Detail

Index.values

A 1D NumPy array of the values in the Index. This array will have the same dtype…

Index: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary | Operator Unary | Accessor Datetime | Accessor String

Index: Display

Detail: Index: Display

Detail

Index.interface

A Frame documenting the interface of this class.

Detail

Index.__repr__()

Detail

Index.__str__()

Return str(self).

Detail

Index.display(config)

Return a Display, capable of providing a string representation. Args: config: A…

Detail

Index.display_tall(config)

Maximize vertical presentation. Return a Display, capable of providing a string…

Detail

Index.display_wide(config)

Maximize horizontal presentation. Return a Display, capable of providing a strin…

Index: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary | Operator Unary | Accessor Datetime | Accessor String

Index: Selector

Detail: Index: Selector

Detail

Index.drop.iloc[key]

Detail

Index.drop.loc[key]

Detail

Index[key]

Extract a new index given an iloc key.

Detail

Index.iloc[key]

Detail

Index.loc[key]

Index: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary | Operator Unary | Accessor Datetime | Accessor String

Index: Iterator

Detail: Index: Iterator

Detail

Index.iter_label(depth_level)

Detail

Index.iter_label(depth_level).apply(func, *, dtype, name)

Apply a function to each value. Returns a new container. Args: func: A function…

Detail

Index.iter_label(depth_level).apply_iter(func)

Apply a function to each value. A generator of resulting values. Args: func: A f…

Detail

Index.iter_label(depth_level).apply_iter_items(func)

Apply a function to each value. A generator of resulting key, value pairs. Args:…

Detail

Index.iter_label(depth_level).apply_pool(func, *, dtype, name, max_workers, chunksize, use_threads)

Apply a function to each value. Employ parallel processing with either the Proce…

Detail

Index.iter_label(depth_level).map_all(mapping, *, dtype, name)

Apply a mapping; for values not in the mapping, an Exception is raised. Returns…

Detail

Index.iter_label(depth_level).map_all_iter(mapping)

Apply a mapping; for values not in the mapping, an Exception is raised. A genera…

Detail

Index.iter_label(depth_level).map_all_iter_items(mapping)

Apply a mapping; for values not in the mapping, an Exception is raised. A genera…

Detail

Index.iter_label(depth_level).map_any(mapping, *, dtype, name)

Apply a mapping; for values not in the mapping, the value is returned. Returns a…

Detail

Index.iter_label(depth_level).map_any_iter(mapping)

Apply a mapping; for values not in the mapping, the value is returned. A generat…

Detail

Index.iter_label(depth_level).map_any_iter_items(mapping)

Apply a mapping; for values not in the mapping, the value is returned. A generat…

Detail

Index.iter_label(depth_level).map_fill(mapping, *, fill_value, dtype, name)

Apply a mapping; for values not in the mapping, the fill_value is returned. Retu…

Detail

Index.iter_label(depth_level).map_fill_iter(mapping, *, fill_value)

Apply a mapping; for values not in the mapping, the fill_value is returned. A ge…

Detail

Index.iter_label(depth_level).map_fill_iter_items(mapping, *, fill_value)

Apply a mapping; for values not in the mapping, the fill_value is returned. A ge…

Index: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary | Operator Unary | Accessor Datetime | Accessor String

Index: Operator Binary

Detail: Index: Operator Binary

Detail

Index.__add__(other)

Detail

Index.__and__(other)

Detail

Index.__eq__(other)

Detail

Index.__floordiv__(other)

Detail

Index.__ge__(other)

Detail

Index.__gt__(other)

Detail

Index.__le__(other)

Detail

Index.__lt__(other)

Detail

Index.__matmul__(other)

Detail

Index.__mod__(other)

Detail

Index.__mul__(other)

Detail

Index.__ne__(other)

Detail

Index.__or__(other)

Detail

Index.__pow__(other)

Detail

Index.__radd__(other)

Detail

Index.__rfloordiv__(other)

Detail

Index.__rmatmul__(other)

Detail

Index.__rmul__(other)

Detail

Index.__rshift__(other)

Detail

Index.__rsub__(other)

Detail

Index.__rtruediv__(other)

Detail

Index.__sub__(other)

Detail

Index.__truediv__(other)

Detail

Index.__xor__(other)

Index: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary | Operator Unary | Accessor Datetime | Accessor String

Index: Operator Unary

Detail: Index: Operator Unary

Detail

Index.__abs__()

Detail

Index.__invert__()

Detail

Index.__neg__()

Detail

Index.__pos__()

Index: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary | Operator Unary | Accessor Datetime | Accessor String

Index: Accessor Datetime

Detail: Index: Accessor Datetime

Detail

Index.via_dt.year

Return the year of each element.

Detail

Index.via_dt.month

Return the month of each element, between 1 and 12 inclusive.

Detail

Index.via_dt.day

Return the day of each element, between 1 and the number of days in the given mo…

Detail

Index.via_dt.weekday()

Return the day of the week as an integer, where Monday is 0 and Sunday is 6.

Detail

Index.via_dt.timetuple()

Return a time.struct_time such as returned by time.localtime().

Detail

Index.via_dt.fromisoformat()

Return a datetime.date object from an ISO 8601 format.

Detail

Index.via_dt.isoformat(sep, timespec)

Return a string representing the date in ISO 8601 format, YYYY-MM-DD.

Detail

Index.via_dt.strftime(format)

Return a string representing the date, controlled by an explicit format string.

Detail

Index.via_dt.strptime(format)

Return a Python datetime object from parsing a string defined with format.

Detail

Index.via_dt.strpdate(format)

Return a Python date object from parsing a string defined with format.

Index: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary | Operator Unary | Accessor Datetime | Accessor String

Index: Accessor String

Detail: Index: Accessor String

Detail

Index.via_str.capitalize()

Return a container with only the first character of each element capitalized.

Detail

Index.via_str.center(width, fillchar)

Return a container with its elements centered in a string of length width.

Detail

Index.via_str.count(sub, start, end)

Returns a container with the number of non-overlapping occurrences of substring…

Detail

Index.via_str.decode(encoding, errors)

Apply str.decode() to each element. Elements must be bytes.

Detail

Index.via_str.encode(encoding, errors)

Apply str.encode() to each element. Elements must be strings.

Detail

Index.via_str.endswith(suffix, start, end)

Returns a container with the number of non-overlapping occurrences of substring…

Detail

Index.via_str.find(sub, start, end)

For each element, return the lowest index in the string where substring sub is f…

Detail

Index.via_str.index(sub, start, end)

Like find, but raises ValueError when the substring is not found.

Detail

Index.via_str.isalnum()

Returns true for each element if all characters in the string are alphanumeric a…

Detail

Index.via_str.isalpha()

Returns true for each element if all characters in the string are alphabetic and…

Detail

Index.via_str.isdecimal()

For each element, return True if there are only decimal characters in the elemen…

Detail

Index.via_str.isdigit()

Returns true for each element if all characters in the string are digits and the…

Detail

Index.via_str.islower()

Returns true for each element if all cased characters in the string are lowercas…

Detail

Index.via_str.isnumeric()

For each element in self, return True if there are only numeric characters in th…

Detail

Index.via_str.isspace()

Returns true for each element if there are only whitespace characters in the str…

Detail

Index.via_str.istitle()

Returns true for each element if the element is a titlecased string and there is…

Detail

Index.via_str.isupper()

Returns true for each element if all cased characters in the string are uppercas…

Detail

Index.via_str.ljust(width, fillchar)

Return a container with its elements ljusted in a string of length width.

Detail

Index.via_str.len()

Return the length of the string.

Detail

Index.via_str.lower()

Return an array with the elements of self converted to lowercase.

Detail

Index.via_str.lstrip(chars)

For each element, return a copy with the leading characters removed.

Detail

Index.via_str.partition(sep)

Partition each element around sep.

Detail

Index.via_str.replace(old, new, count)

Return a container with its elements replaced in a string of length width.

Detail

Index.via_str.rfind(sub, start, end)

For each element, return the highest index in the string where substring sub is…

Detail

Index.via_str.rindex(sub, start, end)

Like rfind, but raises ValueError when the substring sub is not found.

Detail

Index.via_str.rjust(width, fillchar)

Return a container with its elements rjusted in a string of length width.

Detail

Index.via_str.rpartition(sep)

Partition (split) each element around the right-most separator.

Detail

Index.via_str.rsplit(sep, maxsplit)

For each element, return a tuple of the words in the string, using sep as the de…

Detail

Index.via_str.rstrip(chars)

For each element, return a copy with the trailing characters removed.

Detail

Index.via_str.split(sep, maxsplit)

For each element, return a tuple of the words in the string, using sep as the de…

Detail

Index.via_str.startswith(prefix, start, end)

Returns a container with the number of non-overlapping occurrences of substring…

Detail

Index.via_str.strip(chars)

For each element, return a copy with the leading and trailing characters removed…

Detail

Index.via_str.swapcase()

Return a container with uppercase characters converted to lowercase and vice ver…

Detail

Index.via_str.title()

Return a container with uppercase characters converted to lowercase and vice ver…

Detail

Index.via_str.upper()

Return a container with uppercase characters converted to lowercase and vice ver…

Detail

Index.via_str.zfill(width)

Return the string left-filled with zeros.

Index: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary | Operator Unary | Accessor Datetime | Accessor String