Manipulations#

Mutating and copy methods#

Mutibs has many mutating methods, which change the value in-place and return None. Many of these methods have siblings which do the same task but don’t modify the instance and instead return a new copy. These ‘copy’ methods are also available on the immutable Tibs.

Mutibs mutating methods	Tibs/Mutibs copy equivalent
`byte_swap()`	`byte_swapped()`
`insert()`	`inserted()`
`invert()`	`inverted()`
`replace()`	`replaced()`
`reverse()`	`reversed()`
`rotate_left()`	`rotated_left()`
`rotate_right()`	`rotated_right()`
`set()`	`set_at()`
`unset()`	`unset_at()`

The linguistic oddities here are set_at() and unset_at(), as the past-participle of ‘set’ is also ‘set’, so the naming pattern failed (English is annoying sometimes).

Other Mutibs methods#

Not all mutating methods have a copy equivalent - things like clear() don’t make sense for a Tibs, and you can use the + operator to do non-mutating extensions.

Appending and extending#

Use Mutibs.append() for a single bit, Mutibs.extend() to add bits on the right, and Mutibs.extend_left() to add bits on the left:

>>> m = Mutibs('0b101')
>>> m.append(0)
>>> m.extend('0b11')
>>> m
Mutibs('0b101011')
>>> m.extend_left('0b00')
>>> m.bin
'00101011'

Extending to the left is almost certain to need memory reallocation so should be avoided in performance critical code.

For immutable data, use + instead:

>>> Tibs('0b101') + '0b011'
Tibs('0b101011')

Inserting, replacing and deleting#

Mutibs.insert() inserts bits at a position without removing anything:

>>> m = Mutibs('0b1001')
>>> m.insert(2, '0b11')
>>> m
Mutibs('0b101101')

Mutibs.replace() searches for one bit pattern and replaces it with another. It accepts the same start, end, count and byte_aligned options as the non-mutating Tibs.replaced() method, and returns the number of replacements made:

>>> m = Mutibs('0b100100100')
>>> m.replace('0b100', '0b11', count=2)
2
>>> m
Mutibs('0b1111100')

Slices can also be assigned to, or deleted, using normal Python syntax:

>>> m = Mutibs('0b11110000')
>>> m[2:6] = '0b01'
>>> m
Mutibs('0b110100')
>>> del m[1:3]
>>> m.bin
'1100'

Setting and unsetting bits#

Mutibs.set(), Mutibs.unset() and Mutibs.invert() can operate on one position or many positions. Passing a range is the usual way to update a regular pattern efficiently:

>>> m = Mutibs.from_zeros(12)
>>> m.set([0, 3, 4])
>>> m.bin
'100110000000'
>>> m.invert(range(0, 12, 2))
>>> m.bin
'001100101010'

The copy-returning forms are useful when you want expression-style code with an immutable Tibs:

>>> Tibs.from_zeros(8).set_at([1, 6])
Tibs('0x42')

Assigning interpreted values#

The write_u, write_i and write_f methods replace the current bits with a new unsigned integer, signed integer or floating-point value while preserving the existing bit length:

>>> m = Mutibs.from_zeros(8)
>>> m.write_u(15)
>>> m
Mutibs('0x0f')
>>> len(m)
8

The u, i and f properties are settable shortcuts for the same default interpretations:

>>> m.u = 42
>>> m.u
42
>>> m.i = -1
>>> m
Mutibs('0xff')

The value must fit in the current length. Floating-point assignment uses the current length too, so it is only available for 16, 32 and 64-bit Mutibs.

For little-endian or LSB0 interpretations, assign through a mutable view instead:

>>> m = Mutibs.from_u(99, 16, Endianness.Little)
>>> m.le.u
99
>>> m.le.u = 45
>>> m.le.u
45

Mutable views can also select labelled fields and assign through the same properties. The field endpoints are inclusive and interpreted using the view’s current bit order. They can be given in either order, but both endpoints must be zero or positive. Plain Mutibs.field uses the default MSB0 labels:

>>> m = Mutibs('0x23a11234')
>>> m.field(0, 7).hex = '42'
>>> m
Mutibs('0x42a11234')
>>> m.lsb0.le.field(31, 16).u = 0x5678
>>> m
Mutibs('0x42a11e6a')

Unlike assignment on the source Mutibs, assignment through a MutableView cannot change the view’s length. This keeps byte-order, bit-order and field views as fixed mappings onto existing source bits. Use the source Mutibs or slice assignment when the shape needs to change.

Reordering bits#

Use Mutibs.reverse() to reverse the full sequence, or Mutibs.rotate_left() and Mutibs.rotate_right() to rotate either the whole sequence or a selected range:

>>> m = Mutibs('0b10110010')
>>> m.rotate_left(2, start=1, end=7)
>>> m.bin
'11001010'
>>> m.reverse()
>>> m.bin
'01010011'

Mutibs.byte_swap() reverses byte groups. With no argument it reverses the order of all selected bytes; with a byte length it reverses each group of that size. Use start and end to byte-swap only part of a sequence:

>>> m = Mutibs('0x12345678')
>>> m.byte_swap()
>>> m
Mutibs('0x78563412')
>>> m.byte_swap(2)
>>> m
Mutibs('0x56781234')
>>> m.byte_swap(start=8, end=24)
>>> m
Mutibs('0x56127834')

Stack-like operations and capacity#

Mutibs.pop() removes and returns the final bit:

>>> m = Mutibs('0b101')
>>> m.pop()
True
>>> m
Mutibs('0b10')

Mutibs.clear() removes all bits while keeping the object available for reuse. Mutibs.reserve() asks for space for additional bits, and Mutibs.capacity() reports the current allocated capacity. These capacity methods are only performance hints; normal code usually does not need them.