Blender V5.0
Public Member Functions | Protected Attributes | List of all members
blender::bits::BitSpan Class Reference

#include <BLI_bit_span.hh>

Inherited by blender::bits::BoundedBitSpan.

Public Member Functions

 BitSpan ()=default
 BitSpan (const BitInt *data, const int64_t size_in_bits)
 BitSpan (const BitInt *data, const IndexRange bit_range)
int64_t size () const
bool is_empty () const
IndexRange index_range () const
BitRef operator[] (const int64_t index) const
BitSpan slice (const IndexRange range) const
BitSpan take_front (const int64_t n) const
BitSpan take_back (const int64_t n) const
BitSpan drop_front (const int64_t n) const
BitSpan drop_back (const int64_t n) const
const BitInt * data () const
const IndexRange & bit_range () const
BitIterator begin () const
BitIterator end () const

Protected Attributes

const BitInt * data_ = nullptr
IndexRange bit_range_ = {0, 0}

Detailed Description

Similar to Span, but references a range of bits instead of normal C++ types (which must be at least one byte large). Use MutableBitSpan if the values are supposed to be modified.

The beginning and end of a BitSpan does not have to be at byte/int boundaries. It can start and end at any bit.

Definition at line 72 of file BLI_bit_span.hh.

Constructor & Destructor Documentation

◆ BitSpan() [1/3]

blender::bits::BitSpan::BitSpan ( )
default

Construct an empty span.

Referenced by blender::bits::BoundedBitSpan::BoundedBitSpan(), blender::bits::BoundedBitSpan::BoundedBitSpan(), blender::bits::BoundedBitSpan::BoundedBitSpan(), drop_back(), drop_front(), slice(), take_back(), and take_front().

◆ BitSpan() [2/3]

blender::bits::BitSpan::BitSpan ( const BitInt * data,
const int64_t size_in_bits )
inline

Definition at line 84 of file BLI_bit_span.hh.

References bit_range_, data(), and data_.

◆ BitSpan() [3/3]

blender::bits::BitSpan::BitSpan ( const BitInt * data,
const IndexRange bit_range )
inline

Definition at line 88 of file BLI_bit_span.hh.

References bit_range(), bit_range_, data(), and data_.

Member Function Documentation

◆ begin()

BitIterator blender::bits::BitSpan::begin ( ) const
inline

Definition at line 148 of file BLI_bit_span.hh.

References bit_range_, and data_.

◆ bit_range()

const IndexRange & blender::bits::BitSpan::bit_range ( ) const
inline

Definition at line 143 of file BLI_bit_span.hh.

References bit_range_.

Referenced by BitSpan(), blender::bits::BoundedBitSpan::BoundedBitSpan(), blender::bits::is_bounded_span(), blender::bits::tests::TEST(), and blender::bits::try_get_bounded_span().

◆ data()

const BitInt * blender::bits::BitSpan::data ( ) const
inline

Definition at line 138 of file BLI_bit_span.hh.

References data_.

Referenced by BitSpan(), BitSpan(), blender::bits::BitVector< InlineBufferCapacity, Allocator >::BitVector(), blender::bits::BoundedBitSpan::BoundedBitSpan(), blender::bits::BoundedBitSpan::BoundedBitSpan(), blender::bits::tests::TEST(), and blender::bits::try_get_bounded_span().

◆ drop_back()

BitSpan blender::bits::BitSpan::drop_back ( const int64_t n) const
inline

Definition at line 133 of file BLI_bit_span.hh.

References bit_range_, BitSpan(), and data_.

◆ drop_front()

BitSpan blender::bits::BitSpan::drop_front ( const int64_t n) const
inline

Definition at line 128 of file BLI_bit_span.hh.

References bit_range_, BitSpan(), and data_.

◆ end()

BitIterator blender::bits::BitSpan::end ( ) const
inline

Definition at line 153 of file BLI_bit_span.hh.

References bit_range_, and data_.

◆ index_range()

IndexRange blender::bits::BitSpan::index_range ( ) const
inline

Definition at line 101 of file BLI_bit_span.hh.

References bit_range_.

Referenced by blender::bits::tests::TEST().

◆ is_empty()

bool blender::bits::BitSpan::is_empty ( ) const
inline

Definition at line 96 of file BLI_bit_span.hh.

References bit_range_.

Referenced by blender::draw::pbvh::create_lines_index_grids(), blender::draw::pbvh::create_lines_index_grids_flat_layout(), blender::draw::pbvh::create_tri_index_grids(), blender::draw::pbvh::create_tri_index_grids_flat_layout(), blender::draw::extract_edge_factor_mesh(), blender::bke::subdiv::initialize_manifold_index_array(), and blender::bits::tests::TEST().

◆ operator[]()

BitRef blender::bits::BitSpan::operator[] ( const int64_t index) const
inlinenodiscard

Definition at line 106 of file BLI_bit_span.hh.

References bit_range_, BLI_assert, and data_.

◆ size()

int64_t blender::bits::BitSpan::size ( ) const
inline

Number of bits referenced by the span.

Definition at line 91 of file BLI_bit_span.hh.

References bit_range_.

Referenced by blender::bits::BitVector< InlineBufferCapacity, Allocator >::BitVector(), BKE_mesh_mirror_apply_mirror_on_axis_for_modifier(), blender::bits::MutableBitSpan::copy_from(), blender::bits::MutableBitSpan::copy_from(), blender::bits::MutableBoundedBitSpan::copy_from(), blender::bits::MutableBoundedBitSpan::copy_from(), blender::bits::is_bounded_span(), blender::bits::operator<<(), blender::bits::tests::TEST(), blender::bits::tests::TEST(), and blender::bits::try_get_bounded_span().

◆ slice()

BitSpan blender::bits::BitSpan::slice ( const IndexRange range) const
inlinenodiscard

Definition at line 113 of file BLI_bit_span.hh.

References bit_range_, BitSpan(), and data_.

Referenced by blender::bits::tests::TEST().

◆ take_back()

BitSpan blender::bits::BitSpan::take_back ( const int64_t n) const
inline

Definition at line 123 of file BLI_bit_span.hh.

References bit_range_, BitSpan(), and data_.

◆ take_front()

BitSpan blender::bits::BitSpan::take_front ( const int64_t n) const
inline

Definition at line 118 of file BLI_bit_span.hh.

References bit_range_, BitSpan(), and data_.

Member Data Documentation

◆ bit_range_

IndexRange blender::bits::BitSpan::bit_range_ = {0, 0}
protected

The range of referenced bits.

Definition at line 78 of file BLI_bit_span.hh.

Referenced by begin(), bit_range(), BitSpan(), BitSpan(), drop_back(), drop_front(), end(), blender::bits::BoundedBitSpan::final_bits_num(), blender::bits::BoundedBitSpan::full_ints_num(), index_range(), is_empty(), blender::bits::BoundedBitSpan::offset(), operator[](), size(), slice(), take_back(), take_front(), and blender::bits::BoundedBitSpan::take_front().

◆ data_

const BitInt* blender::bits::BitSpan::data_ = nullptr
protected

Base pointer to the integers containing the bits. The actual bit span might start at a much higher address when bit_range_.start() is large.

Definition at line 76 of file BLI_bit_span.hh.

Referenced by begin(), BitSpan(), BitSpan(), data(), drop_back(), drop_front(), end(), operator[](), slice(), take_back(), take_front(), and blender::bits::BoundedBitSpan::take_front().

The documentation for this class was generated from the following file:
Generated on for Blender by  doxygen 1.16.1