BLI: new bit span data structure #104671

Merged
Jacques Lucke merged 26 commits from JacquesLucke/blender:bit-span into main 2023-02-17 00:42:54 +01:00
Member

This adds BitSpan and MutableBitSpan. They work essentially the same as the normal Span and MutableSpan, but work on individual bits instead (The smallest type Span can handle is one byte large).

This also splits up BLI_bit_vector.hh and introduces two new headers: BLI_bit_ref.hh and BLI_bit_span.hh.

The goal here is to make working with dynamically sized bit masks more convenient. I'm mainly working on this because I might want to use this in #104629. It can also be used to cleanup function signatures that currently take a reference to a BitVector. Like with Span vs. Vector, it is better to pass a BitSpan to function than a const BitVector &.

Unit tests for the new code are included.

This adds `BitSpan` and `MutableBitSpan`. They work essentially the same as the normal `Span` and `MutableSpan`, but work on individual bits instead (The smallest type `Span` can handle is one byte large). This also splits up `BLI_bit_vector.hh` and introduces two new headers: `BLI_bit_ref.hh` and `BLI_bit_span.hh`. The goal here is to make working with dynamically sized bit masks more convenient. I'm mainly working on this because I might want to use this in #104629. It can also be used to cleanup function signatures that currently take a reference to a `BitVector`. Like with `Span` vs. `Vector`, it is better to pass a `BitSpan` to function than a `const BitVector &`. Unit tests for the new code are included.
Jacques Lucke added 10 commits 2023-02-12 23:33:29 +01:00
Jacques Lucke changed title from WIP: new bit span data structure to WIP: BLI: new bit span data structure 2023-02-12 23:37:17 +01:00
Author
Member

@blender-bot build

@blender-bot build
Jacques Lucke added 11 commits 2023-02-15 14:33:16 +01:00
Jacques Lucke changed title from WIP: BLI: new bit span data structure to BLI: new bit span data structure 2023-02-15 14:34:43 +01:00
Author
Member

@blender-bot build

@blender-bot build
Jacques Lucke added 1 commit 2023-02-15 14:48:53 +01:00
buildbot/vexp-code-patch-coordinator Build done. Details
9ded8995ce
add missing include
Author
Member

@blender-bot build

@blender-bot build
Jacques Lucke requested review from Hans Goudey 2023-02-15 16:52:37 +01:00
Hans Goudey approved these changes 2023-02-15 18:43:18 +01:00
Hans Goudey left a comment
Member

Looking very nice, it's good to make these more solid.

Not sure if you're interested in including these in this patch, but it would be nice to support some more methods on MutableBitSpan:

  • void copy_from(const BitSpan span)
  • void copy_from(const Span<bool> span)
    Otherwise I'm happy to look into adding them later.
Looking very nice, it's good to make these more solid. Not sure if you're interested in including these in this patch, but it would be nice to support some more methods on `MutableBitSpan`: - `void copy_from(const BitSpan span)` - `void copy_from(const Span<bool> span)` Otherwise I'm happy to look into adding them later.
@ -0,0 +8,4 @@
* This file provides the basis for processing "indexed bits" (i.e. every bit has an index).
* The main purpose of this file is to define how bits are indexed within a memory buffer.
* This is necessary, because there are many different ways to do it. For example, is the first bit
* the least or most significant bit and how does endianness affect the bit order.
Member

"This is necessary, because there are many different ways to do it" seems unnecessary and a bit awkward. The same point is made without the sentence.

"This is necessary, because there are many different ways to do it" seems unnecessary and a bit awkward. The same point is made without the sentence.
JacquesLucke marked this conversation as resolved
@ -0,0 +83,4 @@
class BitRef {
private:
/** Points to the integer that the bit is in. */
const BitInt *data_;
Member

What about calling this int_ to help separate it from the data variables that point to a BitInt array?

What about calling this `int_` to help separate it from the `data` variables that point to a `BitInt` array?
Author
Member

Sounds reasonable.

Sounds reasonable.
JacquesLucke marked this conversation as resolved
@ -0,0 +199,4 @@
/**
* Does the same as #set, but does not use a branch. This is faster when the input value is
* unpredictable for the CPU branch predictor (worst case is a uniform random distribution with
Member

Saying "worst case" here is confusing because from another perspective the uniform random distribution is the best case for the branchless version.

Saying "worst case" here is confusing because from another perspective the uniform random distribution is the best case for the branchless version.
JacquesLucke marked this conversation as resolved
@ -0,0 +59,4 @@
};
/**
* Similar to #Span, but references a range of bits instead of normal C++ types (which are at least
Member

which are -> which must be

`which are` -> `which must be`
JacquesLucke marked this conversation as resolved
@ -0,0 +204,4 @@
}
/** Sets all referenced bits to 1. */
void set()
Member

It seems confusing to have set() and reset() methods for the whole span and for each bit. What about calling the functions on the span set_all() and reset_all(). Some name like fill() would be nice too since it mirrors MutableSpan

It seems confusing to have `set()` and `reset()` methods for the whole span and for each bit. What about calling the functions on the span `set_all()` and `reset_all()`. Some name like `fill()` would be nice too since it mirrors `MutableSpan`
JacquesLucke marked this conversation as resolved
Jacques Lucke added 4 commits 2023-02-16 23:39:14 +01:00
Author
Member

@blender-bot build

@blender-bot build
Jacques Lucke merged commit 891f47b801 into main 2023-02-17 00:42:54 +01:00
Jacques Lucke deleted branch bit-span 2023-02-17 00:42:55 +01:00
Sign in to join this conversation.
No reviewers
No Label
Interest
Alembic
Interest
Animation & Rigging
Interest
Asset Browser
Interest
Asset Browser Project Overview
Interest
Audio
Interest
Automated Testing
Interest
Blender Asset Bundle
Interest
BlendFile
Interest
Collada
Interest
Compatibility
Interest
Compositing
Interest
Core
Interest
Cycles
Interest
Dependency Graph
Interest
Development Management
Interest
EEVEE
Interest
EEVEE & Viewport
Interest
Freestyle
Interest
Geometry Nodes
Interest
Grease Pencil
Interest
ID Management
Interest
Images & Movies
Interest
Import Export
Interest
Line Art
Interest
Masking
Interest
Metal
Interest
Modeling
Interest
Modifiers
Interest
Motion Tracking
Interest
Nodes & Physics
Interest
OpenGL
Interest
Overlay
Interest
Overrides
Interest
Performance
Interest
Physics
Interest
Pipeline, Assets & IO
Interest
Platforms, Builds & Tests
Interest
Python API
Interest
Render & Cycles
Interest
Render Pipeline
Interest
Sculpt, Paint & Texture
Interest
Text Editor
Interest
Translations
Interest
Triaging
Interest
Undo
Interest
USD
Interest
User Interface
Interest
UV Editing
Interest
VFX & Video
Interest
Video Sequencer
Interest
Virtual Reality
Interest
Vulkan
Interest
Wayland
Interest
Workbench
Interest: X11
Legacy
Blender 2.8 Project
Legacy
Milestone 1: Basic, Local Asset Browser
Legacy
OpenGL Error
Meta
Good First Issue
Meta
Papercut
Meta
Retrospective
Meta
Security
Module
Animation & Rigging
Module
Core
Module
Development Management
Module
EEVEE & Viewport
Module
Grease Pencil
Module
Modeling
Module
Nodes & Physics
Module
Pipeline, Assets & IO
Module
Platforms, Builds & Tests
Module
Python API
Module
Render & Cycles
Module
Sculpt, Paint & Texture
Module
Triaging
Module
User Interface
Module
VFX & Video
Platform
FreeBSD
Platform
Linux
Platform
macOS
Platform
Windows
Priority
High
Priority
Low
Priority
Normal
Priority
Unbreak Now!
Status
Archived
Status
Confirmed
Status
Duplicate
Status
Needs Info from Developers
Status
Needs Information from User
Status
Needs Triage
Status
Resolved
Type
Bug
Type
Design
Type
Known Issue
Type
Patch
Type
Report
Type
To Do
No Milestone
No project
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender#104671
No description provided.