IndexHierarchy

Detail: IndexHierarchy

IndexHierarchy: Constructor

Detail: IndexHierarchy: Constructor

Detail

IndexHierarchy.__init__(levels, *, name, blocks, own_blocks)

Initializer. Args: levels: IndexLevels instance, or, optionally, an :objIndexHie…

Detail

IndexHierarchy.from_index_items(items, *, index_constructor)

Given an iterable of pairs of label, Index, produce an IndexHierarchy where the…

Detail

IndexHierarchy.from_labels(labels, *, name, reorder_for_hierarchy, index_constructors, depth_reference, continuation_token)

Construct an IndexHierarhcy from an iterable of labels, where each label is tupl…

Detail

IndexHierarchy.from_labels_delimited(labels, *, delimiter, name, index_constructors)

Construct an IndexHierarchy from an iterable of labels, where each label is stri…

Detail

IndexHierarchy.from_names(names)

Construct a zero-length IndexHierarchy from an iterable of names, where the leng…

Detail

IndexHierarchy.from_pandas(value)

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

Detail

IndexHierarchy.from_product(*, name, *levels)

Given groups of iterables, return an IndexHierarchy made of the product of a val…

Detail

IndexHierarchy.from_tree(tree, *, name)

Convert into a IndexHierarchy a dictionary defining keys to either iterables or…

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

IndexHierarchy: Exporter

Detail: IndexHierarchy: Exporter

Detail

IndexHierarchy.to_frame()

Return Frame version of this IndexHiearchy.

Detail

IndexHierarchy.to_frame_go()

Return a FrameGO version of this IndexHierarchy.

Detail

IndexHierarchy.to_html(config)

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

Detail

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

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

Detail

IndexHierarchy.to_pandas()

Return a Pandas MultiIndex.

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

IndexHierarchy: Attribute

Detail: IndexHierarchy: Attribute

Detail

IndexHierarchy.STATIC

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

Detail

IndexHierarchy.depth

Detail

IndexHierarchy.dtypes

Return a Series of dytpes for each index depth. Returns: Series

Detail

IndexHierarchy.index_types

Return a Series of Index classes for each index depth. Returns: Series

Detail

IndexHierarchy.mloc

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

Detail

IndexHierarchy.name

A hashable label attached to this container. Returns: Hashable

Detail

IndexHierarchy.names

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

Detail

IndexHierarchy.nbytes

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

Detail

IndexHierarchy.ndim

Return the number of dimensions. Returns: int

Detail

IndexHierarchy.positions

Return the immutable positions array.

Detail

IndexHierarchy.shape

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

Detail

IndexHierarchy.size

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

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

IndexHierarchy: Method

Detail: IndexHierarchy: Method

Detail

IndexHierarchy.__bool__()

Raises ValueError to prohibit ambiguous use of truethy evaluation.

Detail

IndexHierarchy.__copy__()

Return a shallow copy of this IndexHierarchy.

Detail

IndexHierarchy.__deepcopy__(memo)

Detail

IndexHierarchy.__len__()

Detail

IndexHierarchy.all(axis, skipna, out)

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

Detail

IndexHierarchy.any(axis, skipna, out)

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

Detail

IndexHierarchy.astype[key](dtypes, *, consolidate_blocks)

Selector of columns by label. Args: key: A loc selector, either a label, a list…

Detail

IndexHierarchy.astype(dtype)

Apply a single dtype to all columns.

Detail

IndexHierarchy.copy()

Return a shallow copy of this IndexHierarchy.

Detail

IndexHierarchy.cumprod(axis, skipna)

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

Detail

IndexHierarchy.cumsum(axis, skipna)

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

Detail

IndexHierarchy.difference(other)

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

Detail

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

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

Detail

IndexHierarchy.fillna(value)

Return an IndexHierarchy after replacing null (NaN or None) with the supplied va…

Detail

IndexHierarchy.flat()

Return a flat, one-dimensional index of tuples for each level.

Detail

IndexHierarchy.head(count)

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

Detail

IndexHierarchy.iloc_searchsorted(values, *, side_left)

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

Detail

IndexHierarchy.intersection(*others)

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

Detail

IndexHierarchy.isin(other)

Return a Boolean array showing True where one or more of the passed in iterable…

Detail

IndexHierarchy.label_widths_at_depth(depth_level)

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

Detail

IndexHierarchy.level_add(level)

Return an IndexHierarchy with a new root (outer) level added.

Detail

IndexHierarchy.level_drop(count)

Return an IndexHierarchy with one or more leaf levels removed. This might change…

Detail

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

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

Detail

IndexHierarchy.loc_to_iloc(key)

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

Detail

IndexHierarchy.max(axis, skipna)

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

Detail

IndexHierarchy.mean(axis, skipna, out)

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

Detail

IndexHierarchy.median(axis, skipna, out)

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

Detail

IndexHierarchy.min(axis, skipna, out)

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

Detail

IndexHierarchy.prod(axis, skipna, out)

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

Detail

IndexHierarchy.rehierarch(depth_map)

Return a new IndexHierarchy that conforms to the new depth assignments given be…

Detail

IndexHierarchy.relabel(mapper)

Return a new IndexHierarchy with labels replaced by the callable or mapping; ord…

Detail

IndexHierarchy.rename(name)

Return a new Frame with an updated name attribute.

Detail

IndexHierarchy.roll(shift)

Return an IndexHierarchy with values rotated forward and wrapped around (with a…

Detail

IndexHierarchy.sample(count, *, seed)

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

Detail

IndexHierarchy.sort(*, ascending, kind, key)

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

Detail

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

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

Detail

IndexHierarchy.sum(axis, skipna, out)

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

Detail

IndexHierarchy.tail(count)

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

Detail

IndexHierarchy.union(*others)

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

Detail

IndexHierarchy.unique(depth_level)

Return a NumPy array of unique values. Args: depth_level: Specify a single depth…

Detail

IndexHierarchy.values_at_depth(depth_level)

Return an NP array for the depth_level specified. Args: depth_level: a single de…

Detail

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

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

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

IndexHierarchy: Dictionary-Like

Detail: IndexHierarchy: Dictionary-Like

Detail

IndexHierarchy.__contains__(value)

Determine if a leaf loc is contained in this Index.

Detail

IndexHierarchy.__iter__()

Iterate over labels.

Detail

IndexHierarchy.__reversed__()

Returns a reverse iterator on the index labels.

Detail

IndexHierarchy.values

A 2D NumPy array of all values in the IndexHierarchy. As this is a single array,…

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

IndexHierarchy: Display

Detail: IndexHierarchy: Display

Detail

IndexHierarchy.interface

A Frame documenting the interface of this class.

Detail

IndexHierarchy.__repr__()

Detail

IndexHierarchy.__str__()

Return str(self).

Detail

IndexHierarchy.display(config)

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

Detail

IndexHierarchy.display_tall(config)

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

Detail

IndexHierarchy.display_wide(config)

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

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

IndexHierarchy: Selector

Detail: IndexHierarchy: Selector

Detail

IndexHierarchy[key]

Extract a new index given an iloc key.

Detail

IndexHierarchy.iloc[key]

Detail

IndexHierarchy.loc[key]

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

IndexHierarchy: Iterator

Detail: IndexHierarchy: Iterator

Detail

IndexHierarchy.iter_label(depth_level)

Detail

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

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

Detail

IndexHierarchy.iter_label(depth_level).apply_iter(func)

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

Detail

IndexHierarchy.iter_label(depth_level).apply_iter_items(func)

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

Detail

IndexHierarchy.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

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

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

Detail

IndexHierarchy.iter_label(depth_level).map_all_iter(mapping)

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

Detail

IndexHierarchy.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

IndexHierarchy.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

IndexHierarchy.iter_label(depth_level).map_any_iter(mapping)

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

Detail

IndexHierarchy.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

IndexHierarchy.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

IndexHierarchy.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

IndexHierarchy.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…

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

IndexHierarchy: Operator Binary

Detail: IndexHierarchy: Operator Binary

Detail

IndexHierarchy.__add__(other)

Detail

IndexHierarchy.__and__(other)

Detail

IndexHierarchy.__eq__(other)

Detail

IndexHierarchy.__floordiv__(other)

Detail

IndexHierarchy.__ge__(other)

Detail

IndexHierarchy.__gt__(other)

Detail

IndexHierarchy.__le__(other)

Detail

IndexHierarchy.__lt__(other)

Detail

IndexHierarchy.__matmul__(other)

Detail

IndexHierarchy.__mod__(other)

Detail

IndexHierarchy.__mul__(other)

Detail

IndexHierarchy.__ne__(other)

Detail

IndexHierarchy.__or__(other)

Detail

IndexHierarchy.__pow__(other)

Detail

IndexHierarchy.__radd__(other)

Detail

IndexHierarchy.__rfloordiv__(other)

Detail

IndexHierarchy.__rmatmul__(other)

Detail

IndexHierarchy.__rmul__(other)

Detail

IndexHierarchy.__rshift__(other)

Detail

IndexHierarchy.__rsub__(other)

Detail

IndexHierarchy.__rtruediv__(other)

Detail

IndexHierarchy.__sub__(other)

Detail

IndexHierarchy.__truediv__(other)

Detail

IndexHierarchy.__xor__(other)

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

IndexHierarchy: Operator Unary

Detail: IndexHierarchy: Operator Unary

Detail

IndexHierarchy.__abs__()

Detail

IndexHierarchy.__invert__()

Detail

IndexHierarchy.__neg__()

Detail

IndexHierarchy.__pos__()

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

IndexHierarchy: Accessor Datetime

Detail: IndexHierarchy: Accessor Datetime

Detail

IndexHierarchy.via_dt.year

Return the year of each element.

Detail

IndexHierarchy.via_dt.month

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

Detail

IndexHierarchy.via_dt.day

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

Detail

IndexHierarchy.via_dt.weekday()

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

Detail

IndexHierarchy.via_dt.timetuple()

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

Detail

IndexHierarchy.via_dt.fromisoformat()

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

Detail

IndexHierarchy.via_dt.isoformat(sep, timespec)

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

Detail

IndexHierarchy.via_dt.strftime(format)

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

Detail

IndexHierarchy.via_dt.strptime(format)

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

Detail

IndexHierarchy.via_dt.strpdate(format)

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

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

IndexHierarchy: Accessor String

Detail: IndexHierarchy: Accessor String

Detail

IndexHierarchy.via_str.capitalize()

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

Detail

IndexHierarchy.via_str.center(width, fillchar)

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

Detail

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

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

Detail

IndexHierarchy.via_str.decode(encoding, errors)

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

Detail

IndexHierarchy.via_str.encode(encoding, errors)

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

Detail

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

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

Detail

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

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

Detail

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

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

Detail

IndexHierarchy.via_str.isalnum()

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

Detail

IndexHierarchy.via_str.isalpha()

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

Detail

IndexHierarchy.via_str.isdecimal()

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

Detail

IndexHierarchy.via_str.isdigit()

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

Detail

IndexHierarchy.via_str.islower()

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

Detail

IndexHierarchy.via_str.isnumeric()

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

Detail

IndexHierarchy.via_str.isspace()

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

Detail

IndexHierarchy.via_str.istitle()

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

Detail

IndexHierarchy.via_str.isupper()

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

Detail

IndexHierarchy.via_str.ljust(width, fillchar)

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

Detail

IndexHierarchy.via_str.len()

Return the length of the string.

Detail

IndexHierarchy.via_str.lower()

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

Detail

IndexHierarchy.via_str.lstrip(chars)

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

Detail

IndexHierarchy.via_str.partition(sep)

Partition each element around sep.

Detail

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

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

Detail

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

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

Detail

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

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

Detail

IndexHierarchy.via_str.rjust(width, fillchar)

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

Detail

IndexHierarchy.via_str.rpartition(sep)

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

Detail

IndexHierarchy.via_str.rsplit(sep, maxsplit)

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

Detail

IndexHierarchy.via_str.rstrip(chars)

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

Detail

IndexHierarchy.via_str.split(sep, maxsplit)

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

Detail

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

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

Detail

IndexHierarchy.via_str.strip(chars)

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

Detail

IndexHierarchy.via_str.swapcase()

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

Detail

IndexHierarchy.via_str.title()

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

Detail

IndexHierarchy.via_str.upper()

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

Detail

IndexHierarchy.via_str.zfill(width)

Return the string left-filled with zeros.

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

IndexHierarchy: Accessor Transpose

Detail: IndexHierarchy: Accessor Transpose

Detail

IndexHierarchy.via_T.__add__(other)

Detail

IndexHierarchy.via_T.__sub__(other)

Detail

IndexHierarchy.via_T.__mul__(other)

Detail

IndexHierarchy.via_T.__truediv__(other)

Detail

IndexHierarchy.via_T.__floordiv__(other)

Detail

IndexHierarchy.via_T.__mod__(other)

Detail

IndexHierarchy.via_T.__pow__(other)

Detail

IndexHierarchy.via_T.__lshift__(other)

Detail

IndexHierarchy.via_T.__rshift__(other)

Detail

IndexHierarchy.via_T.__and__(other)

Detail

IndexHierarchy.via_T.__xor__(other)

Detail

IndexHierarchy.via_T.__or__(other)

Detail

IndexHierarchy.via_T.__lt__(other)

Detail

IndexHierarchy.via_T.__le__(other)

Detail

IndexHierarchy.via_T.__eq__(other)

Detail

IndexHierarchy.via_T.__ne__(other)

Detail

IndexHierarchy.via_T.__gt__(other)

Detail

IndexHierarchy.via_T.__ge__(other)

Detail

IndexHierarchy.via_T.__radd__(other)

Detail

IndexHierarchy.via_T.__rsub__(other)

Detail

IndexHierarchy.via_T.__rmul__(other)

Detail

IndexHierarchy.via_T.__rtruediv__(other)

Detail

IndexHierarchy.via_T.__rfloordiv__(other)

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