## indices


A sparse boolean array, i.e., set of indices.


Usage


``` python
indices(
    *args,
    **kwargs,
)
```


Provides a memory efficient set interface, with optimized conversion between numpy arrays.


## Parameters


`keys: Iterable`  
optional iterable of keys


## Attributes

| Name | Description |
|----|----|
| [__pyx_vtable__](#__pyx_vtable__) | Capsule objects let you wrap a C "void \*" pointer in a Python |

------------------------------------------------------------------------


#### \_\_pyx_vtable\_\_


Capsule objects let you wrap a C "void \*" pointer in a Python


**`pyx_vtable`**`=<capsule object NULL at 0x7fb5e46d6cd0>`


object. They're a way of passing data through the Python interpreter without creating your own custom type.

Capsules are used for communication between extension modules. They provide a way for an extension module to export a C interface to other extension modules, so that extension modules can use the Python import mechanism to link to one another.


## Methods

| Name | Description |
|----|----|
| [__array__()](#__array__) | Return keys as numpy array. |
| [__contains__()](#__contains__) | Return bool(key in self). |
| [__eq__()](#__eq__) | Return self==value. |
| [__ge__()](#__ge__) | Return self\>=value. |
| [__gt__()](#__gt__) | Return self\>value. |
| [__iand__()](#__iand__) | Return self&=value. |
| [__init__()](#__init__) | Initialize self. See help(type(self)) for accurate signature. |
| [__ior__()](#__ior__) | Return self\|=value. |
| [__isub__()](#__isub__) | Return self-=value. |
| [__iter__()](#__iter__) | Implement iter(self). |
| [__ixor__()](#__ixor__) | Return self^=value. |
| [__le__()](#__le__) | Return self\<=value. |
| [__len__()](#__len__) | Return len(self). |
| [__lt__()](#__lt__) | Return self\<value. |
| [__matmul__()](#__matmul__) | Return binary dot product, i.e., intersection count. |
| [__ne__()](#__ne__) | Return self!=value. |
| [__new__()](#__new__) | Create and return a new object. See help(type) for accurate signature. |
| [__rand__()](#__rand__) | Return value&self. |
| [__repr__()](#__repr__) | Return repr(self). |
| [__rmatmul__()](#__rmatmul__) | Return value@self. |
| [__ror__()](#__ror__) | Return value\|self. |
| [__rsub__()](#__rsub__) | Return value-self. |
| [__rxor__()](#__rxor__) | Return value^self. |
| [add()](#add) | Add an index key. |
| [clear()](#clear) | Remove all indices. |
| [difference()](#difference) | Return the difference of sets as a new set. |
| [discard()](#discard) | Remove an index key, if present. |
| [dot()](#dot) | Return the intersection count of sets. |
| [fromdense()](#fromdense) | Return indices from a dense array representation. |
| [intersection()](#intersection) | Return the intersection of sets as a new set. |
| [isdisjoint()](#isdisjoint) | Return whether two indices have a null intersection. |
| [todense()](#todense) | Return a dense array representation of indices. |
| [union()](#union) | Return the union of sets as a new set. |
| [update()](#update) | Update from indices, vector, array, or iterable. |

------------------------------------------------------------------------


#### \_\_array\_\_()


Return keys as numpy array.


Usage


``` python
__array__(dtype=int64, copy=None)
```


------------------------------------------------------------------------


#### \_\_contains\_\_()


Return bool(key in self).


Usage


``` python
__contains__(key)
```


------------------------------------------------------------------------


#### \_\_eq\_\_()


Return self==value.


Usage


``` python
__eq__(value)
```


------------------------------------------------------------------------


#### \_\_ge\_\_()


Return self\>=value.


Usage


``` python
__ge__(value)
```


------------------------------------------------------------------------


#### \_\_gt\_\_()


Return self\>value.


Usage


``` python
__gt__(value)
```


------------------------------------------------------------------------


#### \_\_iand\_\_()


Return self&=value.


Usage


``` python
__iand__(value)
```


------------------------------------------------------------------------


#### \_\_init\_\_()


Initialize self. See help(type(self)) for accurate signature.


Usage


``` python
__init__(*args, **kwargs)
```


------------------------------------------------------------------------


#### \_\_ior\_\_()


Return self\|=value.


Usage


``` python
__ior__(value)
```


------------------------------------------------------------------------


#### \_\_isub\_\_()


Return self-=value.


Usage


``` python
__isub__(value)
```


------------------------------------------------------------------------


#### \_\_iter\_\_()


Implement iter(self).


Usage


``` python
__iter__()
```


------------------------------------------------------------------------


#### \_\_ixor\_\_()


Return self^=value.


Usage


``` python
__ixor__(value)
```


------------------------------------------------------------------------


#### \_\_le\_\_()


Return self\<=value.


Usage


``` python
__le__(value)
```


------------------------------------------------------------------------


#### \_\_len\_\_()


Return len(self).


Usage


``` python
__len__()
```


------------------------------------------------------------------------


#### \_\_lt\_\_()


Return self\<value.


Usage


``` python
__lt__(value)
```


------------------------------------------------------------------------


#### \_\_matmul\_\_()


Return binary dot product, i.e., intersection count.


Usage


``` python
__matmul__()
```


------------------------------------------------------------------------


#### \_\_ne\_\_()


Return self!=value.


Usage


``` python
__ne__(value)
```


------------------------------------------------------------------------


#### \_\_new\_\_()


Create and return a new object. See help(type) for accurate signature.


Usage


``` python
__new__(*args, **kwargs)
```


------------------------------------------------------------------------


#### \_\_rand\_\_()


Return value&self.


Usage


``` python
__rand__(value)
```


------------------------------------------------------------------------


#### \_\_repr\_\_()


Return repr(self).


Usage


``` python
__repr__()
```


------------------------------------------------------------------------


#### \_\_rmatmul\_\_()


Return value@self.


Usage


``` python
__rmatmul__(value)
```


------------------------------------------------------------------------


#### \_\_ror\_\_()


Return value\|self.


Usage


``` python
__ror__(value)
```


------------------------------------------------------------------------


#### \_\_rsub\_\_()


Return value-self.


Usage


``` python
__rsub__(value)
```


------------------------------------------------------------------------


#### \_\_rxor\_\_()


Return value^self.


Usage


``` python
__rxor__(value)
```


------------------------------------------------------------------------


#### add()


Add an index key.


Usage


``` python
add(key)
```


------------------------------------------------------------------------


#### clear()


Remove all indices.


Usage


``` python
clear()
```


------------------------------------------------------------------------


#### difference()


Return the difference of sets as a new set.


Usage


``` python
difference(*others)
```


------------------------------------------------------------------------


#### discard()


Remove an index key, if present.


Usage


``` python
discard(key)
```


------------------------------------------------------------------------


#### dot()


Return the intersection count of sets.


Usage


``` python
dot(*others)
```


------------------------------------------------------------------------


#### fromdense()


Return indices from a dense array representation.


Usage


``` python
fromdense(values)
```


------------------------------------------------------------------------


#### intersection()


Return the intersection of sets as a new set.


Usage


``` python
intersection(*others)
```


------------------------------------------------------------------------


#### isdisjoint()


Return whether two indices have a null intersection.


Usage


``` python
isdisjoint(other)
```


------------------------------------------------------------------------


#### todense()


Return a dense array representation of indices.


Usage


``` python
todense(minlength=0, dtype=bool)
```


------------------------------------------------------------------------


#### union()


Return the union of sets as a new set.


Usage


``` python
union(*others)
```


------------------------------------------------------------------------


#### update()


Update from indices, vector, array, or iterable.


Usage


``` python
update(other)
```