aboutsummaryrefslogtreecommitdiff
path: root/core/container/bit_array
diff options
context:
space:
mode:
Diffstat (limited to 'core/container/bit_array')
-rw-r--r--core/container/bit_array/bit_array.odin2
-rw-r--r--core/container/bit_array/doc.odin75
2 files changed, 38 insertions, 39 deletions
diff --git a/core/container/bit_array/bit_array.odin b/core/container/bit_array/bit_array.odin
index dbd2e0d3a..a8720715c 100644
--- a/core/container/bit_array/bit_array.odin
+++ b/core/container/bit_array/bit_array.odin
@@ -1,4 +1,4 @@
-package dynamic_bit_array
+package container_dynamic_bit_array
import "base:intrinsics"
import "core:mem"
diff --git a/core/container/bit_array/doc.odin b/core/container/bit_array/doc.odin
index 52e252d8a..77e1904a8 100644
--- a/core/container/bit_array/doc.odin
+++ b/core/container/bit_array/doc.odin
@@ -1,53 +1,52 @@
-package dynamic_bit_array
-
/*
- The Bit Array can be used in several ways:
+The Bit Array can be used in several ways:
- -- By default you don't need to instantiate a Bit Array:
+- By default you don't need to instantiate a Bit Array:
- package test
+ package test
- import "core:fmt"
- import "core:container/bit_array"
+ import "core:fmt"
+ import "core:container/bit_array"
- main :: proc() {
- using bit_array
+ main :: proc() {
+ using bit_array
- bits: Bit_Array
+ bits: Bit_Array
- // returns `true`
- fmt.println(set(&bits, 42))
+ // returns `true`
+ fmt.println(set(&bits, 42))
- // returns `false`, `false`, because this Bit Array wasn't created to allow negative indices.
- was_set, was_retrieved := get(&bits, -1)
- fmt.println(was_set, was_retrieved)
- destroy(&bits)
- }
+ // returns `false`, `false`, because this Bit Array wasn't created to allow negative indices.
+ was_set, was_retrieved := get(&bits, -1)
+ fmt.println(was_set, was_retrieved)
+ destroy(&bits)
+ }
- -- A Bit Array can optionally allow for negative indices, if the mininum value was given during creation:
+- A Bit Array can optionally allow for negative indices, if the minimum value was given during creation:
- package test
+ package test
- import "core:fmt"
- import "core:container/bit_array"
+ import "core:fmt"
+ import "core:container/bit_array"
- main :: proc() {
- Foo :: enum int {
- Negative_Test = -42,
- Bar = 420,
- Leaves = 69105,
- }
+ main :: proc() {
+ Foo :: enum int {
+ Negative_Test = -42,
+ Bar = 420,
+ Leaves = 69105,
+ }
- using bit_array
+ using bit_array
- bits := create(int(max(Foo)), int(min(Foo)))
- defer destroy(bits)
+ bits := create(int(max(Foo)), int(min(Foo)))
+ defer destroy(bits)
- fmt.printf("Set(Bar): %v\n", set(bits, Foo.Bar))
- fmt.printf("Get(Bar): %v, %v\n", get(bits, Foo.Bar))
- fmt.printf("Set(Negative_Test): %v\n", set(bits, Foo.Negative_Test))
- fmt.printf("Get(Leaves): %v, %v\n", get(bits, Foo.Leaves))
- fmt.printf("Get(Negative_Test): %v, %v\n", get(bits, Foo.Negative_Test))
- fmt.printf("Freed.\n")
- }
-*/ \ No newline at end of file
+ fmt.printf("Set(Bar): %v\n", set(bits, Foo.Bar))
+ fmt.printf("Get(Bar): %v, %v\n", get(bits, Foo.Bar))
+ fmt.printf("Set(Negative_Test): %v\n", set(bits, Foo.Negative_Test))
+ fmt.printf("Get(Leaves): %v, %v\n", get(bits, Foo.Leaves))
+ fmt.printf("Get(Negative_Test): %v, %v\n", get(bits, Foo.Negative_Test))
+ fmt.printf("Freed.\n")
+ }
+*/
+package container_dynamic_bit_array