col_mapper module¶

Class for mapping column arrays.

ColumnMapper class¶

ColumnMapper(
    wrapper,
    col_arr,
    **kwargs
)

Used by Records and MappedArray classes to make use of column and group metadata.

Superclasses

• AttrResolverMixin
• Base
• Cacheable
• Chainable
• Comparable
• Configured
• ExtPandasIndexer
• HasSettings
• HasWrapper
• IndexApplier
• IndexingBase
• ItemParamable
• Itemable
• PandasIndexer
• Paramable
• Pickleable
• Prettified
• Wrapping

Inherited members

• AttrResolverMixin.deep_getattr
• AttrResolverMixin.post_resolve_attr
• AttrResolverMixin.pre_resolve_attr
• AttrResolverMixin.resolve_attr
• AttrResolverMixin.resolve_shortcut_attr
• Base.chat
• Base.find_api
• Base.find_assets
• Base.find_docs
• Base.find_examples
• Base.find_messages
• Cacheable.get_ca_setup
• Chainable.chain
• Chainable.pipe
• Configured.copy
• Configured.equals
• Configured.get_writeable_attrs
• Configured.prettify
• Configured.replace
• Configured.resolve_merge_kwargs
• Configured.update_config
• HasSettings.get_path_setting
• HasSettings.get_path_settings
• HasSettings.get_setting
• HasSettings.get_settings
• HasSettings.has_path_setting
• HasSettings.has_path_settings
• HasSettings.has_setting
• HasSettings.has_settings
• HasSettings.reset_settings
• HasSettings.resolve_setting
• HasSettings.resolve_settings_paths
• HasSettings.set_settings
• HasWrapper.chunk
• HasWrapper.chunk_apply
• HasWrapper.get_item_keys
• HasWrapper.items
• HasWrapper.select_col
• HasWrapper.select_col_from_obj
• HasWrapper.should_wrap
• HasWrapper.split
• HasWrapper.split_apply
• HasWrapper.ungroup
• IndexApplier.add_levels
• IndexApplier.drop_duplicate_levels
• IndexApplier.drop_levels
• IndexApplier.drop_redundant_levels
• IndexApplier.rename_levels
• IndexApplier.select_levels
• IndexingBase.indexing_setter_func
• ItemParamable.as_param
• PandasIndexer.xs
• Pickleable.decode_config
• Pickleable.decode_config_node
• Pickleable.dumps
• Pickleable.encode_config
• Pickleable.encode_config_node
• Pickleable.file_exists
• Pickleable.getsize
• Pickleable.load
• Pickleable.loads
• Pickleable.modify_state
• Pickleable.resolve_file_path
• Pickleable.save
• Prettified.pprint
• Wrapping.apply_to_index
• Wrapping.cls_dir
• Wrapping.column_only_select
• Wrapping.config
• Wrapping.group_select
• Wrapping.iloc
• Wrapping.indexing_kwargs
• Wrapping.loc
• Wrapping.range_only_select
• Wrapping.rec_state
• Wrapping.regroup
• Wrapping.resample
• Wrapping.resolve_column_stack_kwargs
• Wrapping.resolve_row_stack_kwargs
• Wrapping.resolve_self
• Wrapping.resolve_stack_kwargs
• Wrapping.self_aliases
• Wrapping.unwrapped
• Wrapping.wrapper
• Wrapping.xloc

col_arr class property¶

Column array.

col_lens cached_property¶

Column lengths.

Faster than ColumnMapper.col_map but only compatible with sorted columns.

col_map cached_property¶

Column map.

More flexible than ColumnMapper.col_lens. More suited for mapped arrays.

column_stack class method¶

ColumnMapper.column_stack(
    *objs,
    wrapper_kwargs=None,
    **kwargs
)

Stack multiple ColumnMapper instances along columns.

Uses ArrayWrapper.column_stack to stack the wrappers.

get_col_arr cached_method¶

ColumnMapper.get_col_arr(
    group_by=None
)

Get group-aware column array.

get_col_lens cached_method¶

ColumnMapper.get_col_lens(
    group_by=None,
    jitted=None
)

Get group-aware column lengths.

get_col_map cached_method¶

ColumnMapper.get_col_map(
    group_by=None,
    jitted=None
)

Get group-aware column map.

get_new_id_arr cached_method¶

ColumnMapper.get_new_id_arr(
    group_by=None
)

Generate a new group-aware id array.

indexing_func method¶

ColumnMapper.indexing_func(
    *args,
    col_mapper_meta=None,
    **kwargs
)

Perform indexing on ColumnMapper.

indexing_func_meta method¶

ColumnMapper.indexing_func_meta(
    *args,
    wrapper_meta=None,
    **kwargs
)

Perform indexing on ColumnMapper and return metadata.

is_sorted cached_method¶

ColumnMapper.is_sorted(
    jitted=None
)

Check whether column array is sorted.

new_id_arr cached_property¶

Generate a new id array.

row_stack class method¶

ColumnMapper.row_stack(
    *objs,
    wrapper_kwargs=None,
    **kwargs
)

Stack multiple ColumnMapper instances along rows.

Uses ArrayWrapper.row_stack to stack the wrappers.

select_cols method¶

ColumnMapper.select_cols(
    col_idxs,
    jitted=None
)

Select columns.

Returns indices and new column array. Automatically decides whether to use column lengths or column map.