Kcas

https://ocaml-multicore.github.io/kcas/
Admin
Kcas is a Software Transactional Memory library for OCaml that enables creation of modular,...
Tokens:414,398
Snippets:2,720
Trust Score:8.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Commit Transaction Example (OCaml)

Source: https://ocaml-multicore.github.io/kcas/0.2.4/kcas/Kcas/Tx/index

An example of unconditionally committing a transaction that swaps the values of two shared memory locations and returns their sum. This demonstrates the basic structure of a transaction with `get`, `set`, and sequencing.

```ocaml
commit begin
  let* x = get x_loc
  and* y = get y_loc in
  let+ () = set y_loc x
  and+ () = set x_loc y in
  x + y
end
```

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

### OCaml Promise Creation and Awaiting Example

Source: https://ocaml-multicore.github.io/kcas/0.6.0/kcas_data/Kcas_data/Promise/index

Demonstrates how to create a new promise and resolver, spawn a domain to await the promise's value, resolve the promise with a value, and then join the domain. This showcases the basic asynchronous workflow of promises.

```ocaml
let promise, resolver = Promise.create () in
  let domain = Domain.spawn @@ fun () ->
    Printf.printf "Got %d\n%!" (Promise.await promise)
  in
  Promise.resolve resolver 42;
  Domain.join domain
```

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

### OCaml Promise Creation and Awaiting Example

Source: https://ocaml-multicore.github.io/kcas/0.5.1/kcas_data/Kcas_data/Promise/index

Demonstrates how to create a new promise and resolver, spawn a domain to await the promise's value, resolve the promise with a value, and then join the domain. This showcases the basic asynchronous workflow of promises.

```ocaml
let promise, resolver = Promise.create () in
  let domain = Domain.spawn @@ fun () ->
    Printf.printf "Got %d\n%!" (Promise.await promise)
  in
  Promise.resolve resolver 42;
  Domain.join domain
```

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

### Commit Transaction to Swap Values

Source: https://ocaml-multicore.github.io/kcas/0.2.1/kcas/Kcas/Tx/index

An example of unconditionally committing a transaction that swaps the values of two shared memory locations and returns their sum. It demonstrates the use of `commit`, `let*`, `get`, `set`, and `end`.

```ocaml
commit begin
  let* x = get x_loc
  and* y = get y_loc in
  let+ () = set y_loc x
  and+ () = set x_loc y in
  x + y
end
```

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

### OCaml Promise Creation and Awaiting Example

Source: https://ocaml-multicore.github.io/kcas/0.4.0/kcas_data/Kcas_data/Promise/index

Demonstrates how to create a new promise and resolver, spawn a domain to await the promise's value, resolve the promise with a value, and then join the domain. This showcases the basic asynchronous workflow of promises.

```ocaml
let promise, resolver = Promise.create () in
  let domain = Domain.spawn @@ fun () ->
    Printf.printf "Got %d\n%!" (Promise.await promise)
  in
  Promise.resolve resolver 42;
  Domain.join domain
```

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

### Commit Transaction - Swap and Sum

Source: https://ocaml-multicore.github.io/kcas/0.2.0/kcas/Kcas/Tx/index

An example of unconditionally committing a transaction that swaps the values of two shared memory locations and returns their sum. It demonstrates the use of `commit`, `begin`, `let*`, `get`, `set`, `let+`, and `end`.

```ocaml
commit begin
  let* x = get x_loc
  and* y = get y_loc in
  let+ () = set y_loc x
  and+ () = set x_loc y in
  x + y
end
```

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

### OCaml Promise Creation and Awaiting Example

Source: https://ocaml-multicore.github.io/kcas/0.6.1/kcas_data/Kcas_data/Promise/index

Demonstrates how to create a new promise and resolver, spawn a domain to await the promise's value, resolve the promise with a value, and then join the domain. This showcases the basic asynchronous workflow of promises.

```ocaml
let promise, resolver = Promise.create () in
  let domain = Domain.spawn @@ fun () ->
    Printf.printf "Got %d\n%!" (Promise.await promise)
  in
  Promise.resolve resolver 42;
  Domain.join domain
```

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

### Attempt Conditional Transaction (Forget)

Source: https://ocaml-multicore.github.io/kcas/0.2.1/kcas/Kcas/Tx/index

An example of attempting a conditional transaction that reads `x_loc`. If `x_loc` is negative, the access is forgotten, and it proceeds to read `y_loc`. This illustrates `attempt`, `begin`, `let*`, `get`, `if`, `forget`, `else`, `return`, `<|>`.

```ocaml
attempt begin
  begin
    let* x = get x_loc in
    if x < 0 then
      forget
    else
      return x
  end
  <|> get y_loc
end
```

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

### OCaml Promise Creation and Awaiting Example

Source: https://ocaml-multicore.github.io/kcas/0.5.3/kcas_data/Kcas_data/Promise/index

Demonstrates how to create a new promise and resolver, spawn a domain to await the promise's value, resolve the promise with a value, and then join the domain. This showcases the basic asynchronous workflow of promises.

```ocaml
let promise, resolver = Promise.create () in
  let domain = Domain.spawn @@ fun () ->
    Printf.printf "Got %d\n%!" (Promise.await promise)
  in
  Promise.resolve resolver 42;
  Domain.join domain
```

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

### Attempt Conditional Transaction - Forget Negative

Source: https://ocaml-multicore.github.io/kcas/0.2.0/kcas/Kcas/Tx/index

An example of attempting a conditional transaction that reads a shared memory location. If the value is negative, the access is forgotten; otherwise, the value is returned. It showcases `attempt`, `begin`, `let*`, `get`, `if`, `forget`, `else`, `return`, and `<|>`.

```ocaml
attempt begin
  begin
    let* x = get x_loc in
    if x < 0 then
      forget
    else
      return x
  end
  <|> get y_loc
end
```

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

### OCaml: Get Value with Mapping Function

Source: https://ocaml-multicore.github.io/kcas/0.2.3/kcas/Kcas/Tx/index

Defines `get_as`, which is equivalent to `get` followed by a `map` operation, allowing transformation of the accessed value.

```ocaml
val get_as : ('a -> 'b) -> 'a Loc.t -> 'b t
```

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

### OCaml Promise Creation and Awaiting Example

Source: https://ocaml-multicore.github.io/kcas/0.5.0/kcas_data/Kcas_data/Promise/index

Demonstrates creating a promise, spawning a domain to await its resolution, and then resolving the promise with a value. This showcases basic asynchronous operations with promises.

```ocaml
let promise, resolver = Promise.create () in
  let domain = Domain.spawn @@ fun () ->
    Printf.printf "Got %d\n%!" (Promise.await promise)
  in
  Promise.resolve resolver 42;
  Domain.join domain
```

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

### OCaml Promise Creation and Awaiting Example

Source: https://ocaml-multicore.github.io/kcas/0.5.2/kcas_data/Kcas_data/Promise/index

Demonstrates creating a promise, spawning a domain to await its resolution, and then resolving the promise with a value. This showcases basic asynchronous operations with promises.

```ocaml
let promise, resolver = Promise.create () in
  let domain = Domain.spawn @@ fun () ->
    Printf.printf "Got %d\n%!" (Promise.await promise)
  in
  Promise.resolve resolver 42;
  Domain.join domain
```

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

### OCaml: Get Value with Mapping Function

Source: https://ocaml-multicore.github.io/kcas/0.2.2/kcas/Kcas/Tx/index

Defines `get_as`, which is equivalent to `get` followed by a `map` operation, allowing transformation of the accessed value.

```ocaml
val get_as : ('a -> 'b) -> 'a Loc.t -> 'b t
```

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

### Create and Await a Promise in OCaml

Source: https://ocaml-multicore.github.io/kcas/doc/kcas_data/Kcas_data/Promise/index

Demonstrates the creation of a promise and its associated resolver, spawning a domain to await the promise's resolution, and then resolving the promise with a value.

```ocaml
let promise, resolver = Promise.create () in
  let domain = Domain.spawn @@ fun () ->
    Printf.printf "Got %d\n%!" (Promise.await promise)
  in
  Promise.resolve resolver 42;
  Domain.join domain
```

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

### OCaml Kcas_data Accumulator - Get

Source: https://ocaml-multicore.github.io/kcas/doc/kcas_data/Kcas_data/Accumulator/index

Retrieves the current integer value of the scalable accumulator. Note: Performing 'get' can be expensive and may limit scalability.

```ocaml
val get : t -> int
get a returns the current value of the accumulator.
```

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

### OCaml Kcas_data Accumulator Get Function

Source: https://ocaml-multicore.github.io/kcas/0.6.1/kcas_data/Kcas_data/Accumulator/index

Describes the 'get' function for retrieving the current value of the accumulator, with a caution that this operation can be expensive and impact scalability.

```ocaml
val get : t -> int
```

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

### Create and Await a Promise in OCaml

Source: https://ocaml-multicore.github.io/kcas/0.7.0/kcas_data/Kcas_data/Promise/index

Demonstrates the creation of a promise and its associated resolver, spawning a domain to await the promise's resolution, and then resolving the promise with a value.

```ocaml
let promise, resolver = Promise.create () in
  let domain = Domain.spawn @@ fun () ->
    Printf.printf "Got %d\n%!" (Promise.await promise)
  in
  Promise.resolve resolver 42;
  Domain.join domain
```

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

### OCaml Kcas_data Accumulator Get Function

Source: https://ocaml-multicore.github.io/kcas/0.6.0/kcas_data/Kcas_data/Accumulator/index

Describes the 'get' function for retrieving the current value of the accumulator, with a caution that this operation can be expensive and impact scalability.

```ocaml
val get : t -> int
```

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

### OCaml Kcas_data Stack Copying and Initialization

Source: https://ocaml-multicore.github.io/kcas/doc/kcas_data/Kcas_data/Stack/index

Shows how to create a copy of an existing stack and how to initialize a stack from a sequence of elements.

```ocaml
val copy : 'a t -> 'a t
copy s

val of_seq : 'a Stdlib.Seq.t -> 'a t
of_seq xs
```

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

### Create and Await a Promise - OCaml

Source: https://ocaml-multicore.github.io/kcas/0.3.0/kcas_data/Kcas_data/Promise/index

Demonstrates the creation of a promise and its associated resolver, spawning a domain to await the promise's resolution, and then resolving the promise with a value.

```ocaml
let promise, resolver = Promise.create () in
  let domain = Domain.spawn @@ fun () ->
    Printf.printf "Got %d\n%!" (Promise.await promise)
  in
  Promise.resolve resolver 42;
  Domain.join domain
```

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

### OCaml Kcas_data Accumulator Get Function

Source: https://ocaml-multicore.github.io/kcas/0.5.3/kcas_data/Kcas_data/Accumulator/index

Describes the 'get' function for retrieving the current value of the accumulator, with a caution that this operation can be expensive and impact scalability.

```ocaml
val get : t -> int
```

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

### OCaml Kcas_data Stack Copying and Initialization

Source: https://ocaml-multicore.github.io/kcas/0.7.0/kcas_data/Kcas_data/Stack/index

Shows how to create a copy of an existing stack and how to initialize a stack from a sequence of elements.

```ocaml
val copy : 'a t -> 'a t
copy s

val of_seq : 'a Stdlib.Seq.t -> 'a t
of_seq xs
```

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

### OCaml Kcas_data Accumulator Get Function

Source: https://ocaml-multicore.github.io/kcas/0.5.2/kcas_data/Kcas_data/Accumulator/index

Describes the 'get' function for retrieving the current value of the accumulator, with a caution that this operation can be expensive and impact scalability.

```ocaml
val get : t -> int
```

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

### OCaml Kcas_data Accumulator Get Function

Source: https://ocaml-multicore.github.io/kcas/0.5.0/kcas_data/Kcas_data/Accumulator/index

Describes the 'get' function for retrieving the current value of the accumulator, with a caution that this operation can be expensive and impact scalability.

```ocaml
val get : t -> int
```

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

### Create and Await a Promise - OCaml

Source: https://ocaml-multicore.github.io/kcas/0.3.1/kcas_data/Kcas_data/Promise/index

Demonstrates the creation of a promise and its associated resolver, spawning a domain to await the promise's resolution, and then resolving the promise with a value.

```ocaml
let promise, resolver = Promise.create () in
  let domain = Domain.spawn @@ fun () ->
    Printf.printf "Got %d\n%!" (Promise.await promise)
  in
  Promise.resolve resolver 42;
  Domain.join domain
```

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

### OCaml Kcas_data Accumulator Get Function

Source: https://ocaml-multicore.github.io/kcas/0.4.0/kcas_data/Kcas_data/Accumulator/index

Describes the 'get' function for retrieving the current value of the accumulator, with a caution that this operation can be expensive and impact scalability.

```ocaml
val get : t -> int
```

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

### Find All Bindings for a Key

Source: https://ocaml-multicore.github.io/kcas/0.7.0/kcas_data/Kcas_data/Hashtbl/index

Returns a list of all bindings for a given key, in reverse order of their introduction.

```OCaml
val find_all : ('k, 'v) t -> 'k -> 'v list
```

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

### Ocaml KCAS Hash Table: Rebuild

Source: https://ocaml-multicore.github.io/kcas/doc/kcas_data/Kcas_data/Hashtbl/index

Returns a copy of the hash table, optionally rehashing all bindings. Uses the provided table as a template for default parameters. See 'create' for parameter descriptions.

```ocaml
val rebuild : ?hashed_type:'k hashed_type -> ?min_buckets:int -> ?max_buckets:int -> ('k, 'v) t -> ('k, 'v) t
```

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

### OCaml Kcas_data Accumulator Get Function

Source: https://ocaml-multicore.github.io/kcas/0.3.1/kcas_data/Kcas_data/Accumulator/index

Describes the 'get' function for retrieving the current value of the accumulator, with a caution that this operation can be expensive and impact scalability.

```ocaml
val get : t -> int
```

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

### OCaml Kcas_data Accumulator Get Function

Source: https://ocaml-multicore.github.io/kcas/0.3.0/kcas_data/Kcas_data/Accumulator/index

Describes the 'get' function for retrieving the current value of the accumulator, with a caution that this operation can be expensive and impact scalability.

```ocaml
val get : t -> int
```

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

### Create a new doubly-linked list

Source: https://ocaml-multicore.github.io/kcas/0.5.2/kcas_data/Kcas_data/Dllist/index

Initializes and returns a new, empty doubly-linked list.

```ocaml
val create : unit -> 'a t
create () return a new doubly-linked list.
```

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

### Create a new doubly-linked list

Source: https://ocaml-multicore.github.io/kcas/0.5.0/kcas_data/Kcas_data/Dllist/index

Initializes and returns a new, empty doubly-linked list.

```ocaml
val create : unit -> 'a t
create () return a new doubly-linked list.
```

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

### Get Shared Memory Location

Source: https://ocaml-multicore.github.io/kcas/0.2.1/kcas/Kcas/Tx/index

The `get` function accesses a shared memory location `r` within a transaction and returns its current value.

```ocaml
val get : 'a Loc.t -> 'a t
```

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

### Create a new doubly-linked list

Source: https://ocaml-multicore.github.io/kcas/0.4.0/kcas_data/Kcas_data/Dllist/index

Initializes and returns a new, empty doubly-linked list.

```ocaml
val create : unit -> 'a t
create () return a new doubly-linked list.
```

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

### OCaml Kcas_data Accumulator - Get Value

Source: https://ocaml-multicore.github.io/kcas/0.5.1/kcas_data/Kcas_data/Accumulator/index

Retrieves the current value of the accumulator. Caution: Performing a `get` operation is computationally expensive and can negatively impact scalability.

```ocaml
val get : t -> int
```

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

### Find All Bindings for a Key in Hashtbl.Xt

Source: https://ocaml-multicore.github.io/kcas/doc/kcas_data/Kcas_data/Hashtbl/Xt/index

Returns a list of all bindings for a given key `k` in the hash table `t`, in reverse order of their introduction.

```OCaml
val find_all : xt:'x Kcas.Xt.t -> ('k, 'v) t -> 'k -> 'v list
find_all t k
(* returns a list of all the bindings of the key `k` in the hash table in reverse order of their introduction. *)
```

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

### OCaml: Get Value from Shared Memory Location

Source: https://ocaml-multicore.github.io/kcas/0.2.3/kcas/Kcas/Tx/index

Defines the `get` function, which accesses a shared memory location within a transaction and returns its current value.

```ocaml
val get : 'a Loc.t -> 'a t
```

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

### OCaml: Get Value from Shared Memory Location

Source: https://ocaml-multicore.github.io/kcas/0.2.2/kcas/Kcas/Tx/index

Defines the `get` function, which accesses a shared memory location within a transaction and returns its current value.

```ocaml
val get : 'a Loc.t -> 'a t
```

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

### Find All Bindings for a Key (OCaml)

Source: https://ocaml-multicore.github.io/kcas/0.6.0/kcas_data/Kcas_data/Hashtbl/index

Returns a list of all bindings for a given key in reverse order of introduction.

```OCaml
val find_all : ('k, 'v) t -> 'k -> 'v list
```

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

### Get Accumulator Value in OCaml

Source: https://ocaml-multicore.github.io/kcas/0.7.0/kcas_data/Kcas_data/Accumulator/index

Retrieves the current value of the accumulator.  This operation is expensive and can limit scalability, so it should be used infrequently. Consider the performance implications when using `get`.

```OCaml
val get : t -> int
```

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

### Find All Bindings for a Key in Hashtbl.Xt

Source: https://ocaml-multicore.github.io/kcas/0.6.1/kcas_data/Kcas_data/Hashtbl/Xt/index

Returns a list of all bindings for a given key `k` in the hash table `t`, in reverse order of their introduction.

```OCaml
val find_all : xt:'x Kcas.Xt.t -> ('k, 'v) t -> 'k -> 'v list
find_all t k
(* returns a list of all the bindings of the key `k` in the hash table in reverse order of their introduction. *)
```

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

### Find All Bindings for a Key in Hashtbl.Xt

Source: https://ocaml-multicore.github.io/kcas/0.6.0/kcas_data/Kcas_data/Hashtbl/Xt/index

Returns a list of all bindings for a given key `k` in the hash table `t`, in reverse order of their introduction.

```OCaml
val find_all : xt:'x Kcas.Xt.t -> ('k, 'v) t -> 'k -> 'v list
find_all t k
(* returns a list of all the bindings of the key `k` in the hash table in reverse order of their introduction. *)
```

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

### OCaml: Get Accumulator Value

Source: https://ocaml-multicore.github.io/kcas/0.5.1/kcas_data/Kcas_data/Accumulator/Xt/index

Retrieves the current value of an accumulator. Caution: Performing a get operation can be expensive and may limit scalability.

```ocaml
val get : xt:'x Kcas.Xt.t -> t -> int
get a returns the current value of the accumulator.
```

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

### OCaml: Get Accumulator Value

Source: https://ocaml-multicore.github.io/kcas/0.2.4/kcas_data/Kcas_data/Accumulator/Xt/index

Retrieves the current value of an accumulator. Caution: Performing a get operation can be expensive and may limit scalability.

```ocaml
val get : xt:'x Kcas.Xt.t -> t -> int
get a returns the current value of the accumulator.
```

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

### Find All Bindings for a Key (OCaml)

Source: https://ocaml-multicore.github.io/kcas/0.5.2/kcas_data/Kcas_data/Hashtbl/index

Returns a list of all bindings for a given key in reverse order of introduction.

```OCaml
val find_all : ('k, 'v) t -> 'k -> 'v list
```

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

### Find All Bindings for a Key in Hashtbl.Xt

Source: https://ocaml-multicore.github.io/kcas/0.5.2/kcas_data/Kcas_data/Hashtbl/Xt/index

Returns a list of all bindings for a given key `k` in the hash table `t`, in reverse order of their introduction.

```OCaml
val find_all : xt:'x Kcas.Xt.t -> ('k, 'v) t -> 'k -> 'v list
find_all t k
(* returns a list of all the bindings of the key `k` in the hash table in reverse order of their introduction. *)
```

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

### OCaml: Get and Set Accumulator Value

Source: https://ocaml-multicore.github.io/kcas/doc/kcas_data/Kcas_data/Accumulator/Xt/index

Retrieves the current value of an accumulator or sets it to a new value. Note that `get` operations can be expensive and may limit scalability.

```ocaml
val get : xt:'x Kcas.Xt.t -> t -> int
get a returns the current value of the accumulator.
```

```ocaml
val set : xt:'x Kcas.Xt.t -> t -> int -> unit
set a n sets the current value of the accumulator a to n.
```

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

### OCaml: Get and Set Accumulator Value

Source: https://ocaml-multicore.github.io/kcas/0.7.0/kcas_data/Kcas_data/Accumulator/Xt/index

Retrieves the current value of an accumulator or sets it to a new value. Note that `get` operations can be expensive and may limit scalability.

```ocaml
val get : xt:'x Kcas.Xt.t -> t -> int
get a returns the current value of the accumulator.
```

```ocaml
val set : xt:'x Kcas.Xt.t -> t -> int -> unit
set a n sets the current value of the accumulator a to n.
```

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

### Find All Bindings for a Key in Hashtbl.Xt

Source: https://ocaml-multicore.github.io/kcas/0.5.3/kcas_data/Kcas_data/Hashtbl/Xt/index

Returns a list of all bindings for a given key `k` in the hash table `t`, in reverse order of their introduction.

```OCaml
val find_all : xt:'x Kcas.Xt.t -> ('k, 'v) t -> 'k -> 'v list
find_all t k
(* returns a list of all the bindings of the key `k` in the hash table in reverse order of their introduction. *)
```

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

### OCaml Kcas_data Stack: Create, Copy, and Convert

Source: https://ocaml-multicore.github.io/kcas/0.2.4/kcas_data/Kcas_data/Stack/index

Demonstrates the creation, copying, and conversion of stacks using the Kcas_data.Stack module. It includes functions to create new stacks, duplicate existing ones, and initialize stacks from sequences.

```OCaml
val create : unit -> 'a t
(* create () returns a new empty stack. *)

val copy : 'a t -> 'a t
(* copy s returns a copy of the stack s. *)

val of_seq : 'a Stdlib.Seq.t -> 'a t
(* of_seq xs creates a stack from the sequence xs. *)
```

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

### OCaml Kcas_data Accumulator Xt: get

Source: https://ocaml-multicore.github.io/kcas/0.6.1/kcas_data/Kcas_data/Accumulator/Xt/index

Retrieves the current value of the accumulator. Note that performing a `get` operation can be computationally expensive and may limit scalability.

```ocaml
val get : xt:'x Kcas.Xt.t -> t -> int
```

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

### OCaml: Get and Set Accumulator Value

Source: https://ocaml-multicore.github.io/kcas/0.6.0/kcas_data/Kcas_data/Accumulator/Xt/index

Retrieves the current value of an accumulator or sets it to a new value. Note that `get` operations can be expensive and may limit scalability.

```ocaml
val get : xt:'x Kcas.Xt.t -> t -> int
get a returns the current value of the accumulator.
```

```ocaml
val set : xt:'x Kcas.Xt.t -> t -> int -> unit
set a n sets the current value of the accumulator a to n.
```

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

### Find All Bindings for a Key (OCaml)

Source: https://ocaml-multicore.github.io/kcas/0.5.3/kcas_data/Kcas_data/Hashtbl/index

Returns a list of all bindings for a given key in reverse order of introduction.

```OCaml
val find_all : ('k, 'v) t -> 'k -> 'v list
```

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

### Find All Bindings for a Key in Hashtbl.Xt

Source: https://ocaml-multicore.github.io/kcas/0.7.0/kcas_data/Kcas_data/Hashtbl/Xt/index

Returns a list of all bindings for a given key `k` in the hash table `t`, in reverse order of their introduction.

```OCaml
val find_all : xt:'x Kcas.Xt.t -> ('k, 'v) t -> 'k -> 'v list
find_all t k
(* returns a list of all the bindings of the key `k` in the hash table in reverse order of their introduction. *)
```

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

### OCaml: Get and Set Accumulator Value

Source: https://ocaml-multicore.github.io/kcas/0.5.3/kcas_data/Kcas_data/Accumulator/Xt/index

Retrieves the current value of an accumulator or sets it to a new value. Note that `get` operations can be expensive and may limit scalability.

```ocaml
val get : xt:'x Kcas.Xt.t -> t -> int
get a returns the current value of the accumulator.
```

```ocaml
val set : xt:'x Kcas.Xt.t -> t -> int -> unit
set a n sets the current value of the accumulator a to n.
```

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

### OCaml: Get and Set Accumulator Value

Source: https://ocaml-multicore.github.io/kcas/0.5.2/kcas_data/Kcas_data/Accumulator/Xt/index

Retrieves the current value of an accumulator or sets it to a new value. Note that `get` operations can be expensive and may limit scalability.

```ocaml
val get : xt:'x Kcas.Xt.t -> t -> int
get a returns the current value of the accumulator.
```

```ocaml
val set : xt:'x Kcas.Xt.t -> t -> int -> unit
set a n sets the current value of the accumulator a to n.
```

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

### OCaml Hashtbl.Xt: Find All Bindings for a Key

Source: https://ocaml-multicore.github.io/kcas/0.5.0/kcas_data/Kcas_data/Hashtbl/Xt/index

The `find_all` function returns a list of all bindings for a given key `k` in the hash table `t`, ordered in reverse of their introduction.

```OCaml
val find_all : xt:'x Kcas.Xt.t -> ('k, 'v) t -> 'k -> 'v list
find_all t k returns a list of all the bindings of the key `k` in the hash table in reverse order of their introduction.
```

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

### OCaml Hashtbl.Xt: Find All Bindings for a Key

Source: https://ocaml-multicore.github.io/kcas/0.4.0/kcas_data/Kcas_data/Hashtbl/Xt/index

The `find_all` function returns a list of all bindings for a given key `k` in the hash table `t`, ordered in reverse of their introduction.

```OCaml
val find_all : xt:'x Kcas.Xt.t -> ('k, 'v) t -> 'k -> 'v list
find_all t k returns a list of all the bindings of the key `k` in the hash table in reverse order of their introduction.
```

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

### OCaml: Get and Set Accumulator Value

Source: https://ocaml-multicore.github.io/kcas/0.5.0/kcas_data/Kcas_data/Accumulator/Xt/index

Retrieves the current value of an accumulator or sets it to a new value. Note that `get` operations can be expensive and may limit scalability.

```ocaml
val get : xt:'x Kcas.Xt.t -> t -> int
get a returns the current value of the accumulator.
```

```ocaml
val set : xt:'x Kcas.Xt.t -> t -> int -> unit
set a n sets the current value of the accumulator a to n.
```

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

### OCaml Kcas_data Accumulator Xt: get

Source: https://ocaml-multicore.github.io/kcas/0.4.0/kcas_data/Kcas_data/Accumulator/Xt/index

Retrieves the current value of the accumulator. Note that performing a `get` operation can be computationally expensive and may limit scalability.

```ocaml
val get : xt:'x Kcas.Xt.t -> t -> int
```

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

### OCaml KCAS Hash Table Find All Bindings

Source: https://ocaml-multicore.github.io/kcas/0.2.4/kcas_data/Kcas_data/Hashtbl/index

Returns a list of all bindings for a given key, in reverse order of their introduction.

```ocaml
val find_all : ('k, 'v) t -> 'k -> 'v list
```

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

### OCaml KCAS Hash Table Find All Bindings

Source: https://ocaml-multicore.github.io/kcas/0.5.0/kcas_data/Kcas_data/Hashtbl/index

Returns a list of all bindings for a given key, in reverse order of their introduction.

```ocaml
val find_all : ('k, 'v) t -> 'k -> 'v list
```

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

### OCaml Kcas.Xt: Get Shared Memory Value

Source: https://ocaml-multicore.github.io/kcas/0.3.1/kcas/Kcas/Xt/index

Retrieves the current value of a shared memory location from an explicit transaction log using the `get` function in Kcas.Xt.

```ocaml
val get : xt:'x t -> 'a Loc.t -> 'a
```

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

### OCaml Kcas_data Accumulator Xt: get

Source: https://ocaml-multicore.github.io/kcas/0.3.1/kcas_data/Kcas_data/Accumulator/Xt/index

Retrieves the current value of the accumulator. Note that performing a `get` operation can be computationally expensive and may limit scalability.

```ocaml
val get : xt:'x Kcas.Xt.t -> t -> int
```

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

### OCaml KCAS Hash Table Find All Bindings

Source: https://ocaml-multicore.github.io/kcas/0.5.1/kcas_data/Kcas_data/Hashtbl/index

Returns a list of all bindings for a given key, in reverse order of their introduction.

```ocaml
val find_all : ('k, 'v) t -> 'k -> 'v list
```

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

### OCaml Kcas.Xt: Get Shared Memory Value

Source: https://ocaml-multicore.github.io/kcas/0.3.0/kcas/Kcas/Xt/index

Retrieves the current value of a shared memory location from an explicit transaction log using the `get` function in Kcas.Xt.

```ocaml
val get : xt:'x t -> 'a Loc.t -> 'a
```

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

### OCaml KCAS Hash Table Find All Bindings

Source: https://ocaml-multicore.github.io/kcas/0.3.1/kcas_data/Kcas_data/Hashtbl/index

Returns a list of all bindings for a given key, in reverse order of their introduction.

```ocaml
val find_all : ('k, 'v) t -> 'k -> 'v list
```

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

### OCaml: Get and Set Accumulator Value

Source: https://ocaml-multicore.github.io/kcas/0.3.0/kcas_data/Kcas_data/Accumulator/Xt/index

Retrieves the current value of an accumulator or sets it to a new value. Note that `get` operations can be expensive and may limit scalability.

```ocaml
val get : xt:'x Kcas.Xt.t -> t -> int
get a returns the current value of the accumulator.
```

```ocaml
val set : xt:'x Kcas.Xt.t -> t -> int -> unit
set a n sets the current value of the accumulator a to n.
```

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

### OCaml KCAS Hash Table Find All Bindings

Source: https://ocaml-multicore.github.io/kcas/0.3.0/kcas_data/Kcas_data/Hashtbl/index

Returns a list of all bindings for a given key, in reverse order of their introduction.

```ocaml
val find_all : ('k, 'v) t -> 'k -> 'v list
```

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

### LRU Cache Get Operation (Sequential)

Source: https://ocaml-multicore.github.io/kcas/0.7.0/kcas_data/Kcas_data/index

Implements the get operation for a sequential LRU cache. It retrieves a value by key and moves the corresponding node to the front of the doubly-linked list.

```ocaml
let get_opt {table; order; _} key =
  Hashtbl.find_opt table key
  |> Option.map @@ fun (node, datum) ->
     Dllist.move_l node order; datum
```

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

### OCaml KCAS Hash Table Find All Bindings

Source: https://ocaml-multicore.github.io/kcas/0.4.0/kcas_data/Kcas_data/Hashtbl/index

Returns a list of all bindings for a given key, in reverse order of their introduction.

```ocaml
val find_all : ('k, 'v) t -> 'k -> 'v list
```

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

### OCaml kcas_data Accumulator Tx: Get Operation

Source: https://ocaml-multicore.github.io/kcas/0.2.4/kcas_data/Kcas_data/Accumulator/Tx/index

Retrieves the current value of an accumulator within a Kcas transaction. Caution: Performing a `get` operation can be expensive and may limit scalability.

```ocaml
val get : t -> int Kcas.Tx.t
get a returns the current value of the accumulator.
```

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

### Find All Bindings for a Key in Hashtbl.Xt

Source: https://ocaml-multicore.github.io/kcas/0.5.1/kcas_data/Kcas_data/Hashtbl/Xt/index

Returns a list of all bindings for a given key in the hash table, in reverse order of their introduction.

```OCaml
val find_all : xt:'x Kcas.Xt.t -> ('k, 'v) t -> 'k -> 'v list
find_all t k
(* returns a list of all the bindings of the key `k` in the hash table in reverse order of their introduction. *)
```

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

### Find All Bindings for a Key in Hashtbl.Xt

Source: https://ocaml-multicore.github.io/kcas/0.3.1/kcas_data/Kcas_data/Hashtbl/Xt/index

Returns a list of all bindings for a given key in the hash table, in reverse order of their introduction.

```OCaml
val find_all : xt:'x Kcas.Xt.t -> ('k, 'v) t -> 'k -> 'v list
find_all t k
(* returns a list of all the bindings of the key `k` in the hash table in reverse order of their introduction. *)
```

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

### Modify Shared Memory Location

Source: https://ocaml-multicore.github.io/kcas/0.2.1/kcas/Kcas/Tx/index

The `modify` function is equivalent to `let* x = get r in set r (f x)`. It gets the value of `r` and sets it to the result of applying `f`.

```ocaml
val modify : 'a Loc.t -> ('a -> 'a) -> unit t
```

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

### Find All Bindings for a Key in Hashtbl.Xt

Source: https://ocaml-multicore.github.io/kcas/0.3.0/kcas_data/Kcas_data/Hashtbl/Xt/index

Returns a list of all bindings for a given key in the hash table, in reverse order of their introduction.

```OCaml
val find_all : xt:'x Kcas.Xt.t -> ('k, 'v) t -> 'k -> 'v list
find_all t k
(* returns a list of all the bindings of the key `k` in the hash table in reverse order of their introduction. *)
```

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

### Get Shared Memory Location with Mapping

Source: https://ocaml-multicore.github.io/kcas/0.2.1/kcas/Kcas/Tx/index

The `get_as` function is equivalent to `get r |> map g`, accessing a shared memory location `r` and applying a mapping function `g` to its value.

```ocaml
val get_as : ('a -> 'b) -> 'a Loc.t -> 'b t
```

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

### LRU Cache Get Operation (Transactional)

Source: https://ocaml-multicore.github.io/kcas/0.7.0/kcas_data/Kcas_data/index

Provides a transactional version of the LRU cache get operation using Kcas. It uses transactional versions of hash table and doubly-linked list operations.

```ocaml
let get_opt ~xt {table; order; _} key =
  Hashtbl.Xt.find_opt ~xt table key
  |> Option.map @@ fun (node, datum) ->
     Dllist.Xt.move_l ~xt node order; datum
```

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

### Find All Bindings for a Key in Hashtbl.Xt

Source: https://ocaml-multicore.github.io/kcas/0.2.4/kcas_data/Kcas_data/Hashtbl/Xt/index

Returns a list of all bindings for a given key in the hash table, in reverse order of their introduction.

```OCaml
val find_all : xt:'x Kcas.Xt.t -> ('k, 'v) t -> 'k -> 'v list
find_all t k
(* returns a list of all the bindings of the key `k` in the hash table in reverse order of their introduction. *)
```

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

### OCaml Kcas Tx: Find All Hashtbl Bindings

Source: https://ocaml-multicore.github.io/kcas/0.2.4/kcas_data/Kcas_data/Hashtbl/Tx/index

Returns a list of all bindings for a given key in the transactional hash table, in reverse order of their introduction.

```ocaml
val find_all : ('k, 'v) t -> 'k -> 'v list Kcas.Tx.t
```

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

### Attempt Conditional Transaction - Return or Get

Source: https://ocaml-multicore.github.io/kcas/0.2.0/kcas/Kcas/Tx/index

A similar conditional transaction that reads a shared memory location. If the value is negative, it gets the value from another location; otherwise, it returns the original value. This highlights the semantic differences in conditional transactions.

```ocaml
attempt begin
  let* x = get x_loc in
  if x < 0 then
    get y_loc
  else
    return x
end
```

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

### Update Shared Memory Location

Source: https://ocaml-multicore.github.io/kcas/0.2.1/kcas/Kcas/Tx/index

The `update` function is equivalent to `let* x = get r in let+ () = set r (f x) in x`. It gets the value of `r`, applies function `f` to it, and sets the new value.

```ocaml
val update : 'a Loc.t -> ('a -> 'a) -> 'a t
```

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

### OCaml Kcas_data Stack Creation and Basic Operations

Source: https://ocaml-multicore.github.io/kcas/0.7.0/kcas_data/Kcas_data/Stack/index

Demonstrates the creation of a new empty stack and checking if it's empty. This is fundamental for using the Kcas_data.Stack module.

```ocaml
val create : unit -> 'a t
create ()

val is_empty : 'a t -> bool
is_empty s
```

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

### Get Hash Table Statistics

Source: https://ocaml-multicore.github.io/kcas/0.7.0/kcas_data/Kcas_data/Hashtbl/index

Returns statistics about the internal state of the hash table.

```OCaml
val stats : ('a, 'b) t -> Stdlib.Hashtbl.statistics
```

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

### OCaml Kcas: Auxiliary Modules

Source: https://ocaml-multicore.github.io/kcas/0.6.1/kcas/Kcas/index

Kcas includes several auxiliary modules to support its core functionality. `Backoff` provides a randomized exponential backoff mechanism, `Timeout` adds timeout support to operations, `Retry` handles retry logic, and `Mode` defines the operating modes for the k-CAS-n-CMP algorithm.

```ocaml
module Backoff : module type of Backoff
module Timeout : sig ... end
module Retry : sig ... end
module Mode : sig ... end
```

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

### Ocaml: Get Hash Table Statistics

Source: https://ocaml-multicore.github.io/kcas/0.6.1/kcas_data/Kcas_data/Hashtbl/index

Returns statistics about the internal state of the hash table.

```OCaml
val stats : ('a, 'b) t -> Stdlib.Hashtbl.statistics
```

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

### OCaml Kcas: Reference Creation and Comparison

Source: https://ocaml-multicore.github.io/kcas/0.1.8/kcas/Kcas/index

Provides functions to create new shared memory references and to compare them for equality.

```OCaml
val ref : 'a -> 'a ref
val equal : 'a ref -> 'b ref -> bool
```

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

### Get Hash Table Statistics (OCaml)

Source: https://ocaml-multicore.github.io/kcas/0.6.0/kcas_data/Kcas_data/Hashtbl/index

Returns statistics about the internal state of the hash table.

```OCaml
val stats : ('a, 'b) t -> Stdlib.Hashtbl.statistics
```

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

### OCaml Kcas_data Hashtbl Create Function

Source: https://ocaml-multicore.github.io/kcas/0.5.0/kcas_data/Kcas_data/Hashtbl/index

Creates a new empty hash table with optional parameters for hashing, minimum/maximum buckets, and n-way concurrency. The default hash uses randomized bits, and the default equal is (=).

```ocaml
val create :    ?hashed_type:'k hashed_type ->   ?min_buckets:int ->   ?max_buckets:int ->   ?n_way:int ->   unit ->   ('k, 'v) t
```

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

### Get Hash Table Statistics (OCaml)

Source: https://ocaml-multicore.github.io/kcas/0.5.3/kcas_data/Kcas_data/Hashtbl/index

Returns statistics about the internal state of the hash table.

```OCaml
val stats : ('a, 'b) t -> Stdlib.Hashtbl.statistics
```

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

### OCaml Kcas_data Hashtbl Create Function

Source: https://ocaml-multicore.github.io/kcas/0.6.0/kcas_data/Kcas_data/Hashtbl/index

Creates a new empty hash table with optional parameters for hashing, minimum/maximum buckets, and n-way concurrency. The default hash uses randomized bits, and the default equal is (=).

```ocaml
val create :    ?hashed_type:'k hashed_type ->   ?min_buckets:int ->   ?max_buckets:int ->   ?n_way:int ->   unit ->   ('k, 'v) t
```

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

### OCaml Kcas_data Hashtbl Create Function

Source: https://ocaml-multicore.github.io/kcas/0.3.0/kcas_data/Kcas_data/Hashtbl/index

Creates a new empty hash table with optional parameters for hashing, minimum/maximum buckets, and n-way concurrency. The default hash uses randomized bits, and the default equal is (=).

```ocaml
val create :    ?hashed_type:'k hashed_type ->   ?min_buckets:int ->   ?max_buckets:int ->   ?n_way:int ->   unit ->   ('k, 'v) t
```

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

### Get Hash Table Statistics (OCaml)

Source: https://ocaml-multicore.github.io/kcas/0.5.2/kcas_data/Kcas_data/Hashtbl/index

Returns statistics about the internal state of the hash table.

```OCaml
val stats : ('a, 'b) t -> Stdlib.Hashtbl.statistics
```

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

### OCaml Kcas_data Hashtbl Create Function

Source: https://ocaml-multicore.github.io/kcas/0.5.1/kcas_data/Kcas_data/Hashtbl/index

Creates a new empty hash table with optional parameters for hashing, minimum/maximum buckets, and n-way concurrency. The default hash uses randomized bits, and the default equal is (=).

```ocaml
val create :    ?hashed_type:'k hashed_type ->   ?min_buckets:int ->   ?max_buckets:int ->   ?n_way:int ->   unit ->   ('k, 'v) t
```

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

### Kcas.Backoff: Get Current Wait Log

Source: https://ocaml-multicore.github.io/kcas/0.5.3/kcas/Kcas/Backoff/index

Retrieves the logarithm of the maximum wait time for the next `once` operation.

```ocaml
val get_wait_log : t -> int
```

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

### OCaml Kcas_data Hashtbl Create Function

Source: https://ocaml-multicore.github.io/kcas/0.4.0/kcas_data/Kcas_data/Hashtbl/index

Creates a new empty hash table with optional parameters for hashing, minimum/maximum buckets, and n-way concurrency. The default hash uses randomized bits, and the default equal is (=).

```ocaml
val create :    ?hashed_type:'k hashed_type ->   ?min_buckets:int ->   ?max_buckets:int ->   ?n_way:int ->   unit ->   ('k, 'v) t
```

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

### Get value from doubly-linked list node

Source: https://ocaml-multicore.github.io/kcas/0.5.2/kcas_data/Kcas_data/Dllist/index

Retrieves the value stored within a node of a doubly-linked list.

```ocaml
val get : 'a node -> 'a
get node returns the value stored in the node.
```

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

### OCaml Kcas_data Hashtbl Create Function

Source: https://ocaml-multicore.github.io/kcas/0.5.2/kcas_data/Kcas_data/Hashtbl/index

Creates a new empty hash table with optional parameters for hashing, minimum/maximum buckets, and n-way concurrency. The default hash uses randomized bits, and the default equal is (=).

```ocaml
val create :    ?hashed_type:'k hashed_type ->   ?min_buckets:int ->   ?max_buckets:int ->   ?n_way:int ->   unit ->   ('k, 'v) t
```

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

### Get value from doubly-linked list node

Source: https://ocaml-multicore.github.io/kcas/0.5.0/kcas_data/Kcas_data/Dllist/index

Retrieves the value stored within a node of a doubly-linked list.

```ocaml
val get : 'a node -> 'a
get node returns the value stored in the node.
```

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

### Get value from doubly-linked list node

Source: https://ocaml-multicore.github.io/kcas/0.4.0/kcas_data/Kcas_data/Dllist/index

Retrieves the value stored within a node of a doubly-linked list.

```ocaml
val get : 'a node -> 'a
get node returns the value stored in the node.
```

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

### OCaml Kcas_data Hashtbl Create Function

Source: https://ocaml-multicore.github.io/kcas/0.6.1/kcas_data/Kcas_data/Hashtbl/index

Creates a new empty hash table with optional parameters for hashing, minimum/maximum buckets, and n-way concurrency. The default hash uses randomized bits, and the default equal is (=).

```ocaml
val create :    ?hashed_type:'k hashed_type ->   ?min_buckets:int ->   ?max_buckets:int ->   ?n_way:int ->   unit ->   ('k, 'v) t
```

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

### Ocaml KCAS Hash Table: Find All Bindings

Source: https://ocaml-multicore.github.io/kcas/doc/kcas_data/Kcas_data/Hashtbl/index

Returns a list of all bindings for a given key in the hash table, in reverse order of their introduction.

```ocaml
val find_all : ('k, 'v) t -> 'k -> 'v list
```

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

### Kcas.Backoff: Get Current Wait Log

Source: https://ocaml-multicore.github.io/kcas/0.3.0/kcas/Kcas/Backoff/index

Retrieves the logarithm of the maximum wait time for the next `once` operation.

```ocaml
val get_wait_log : t -> int
```

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

### Get Shared Memory Location

Source: https://ocaml-multicore.github.io/kcas/0.2.0/kcas/Kcas/Tx/index

Retrieves the current value of a shared memory location within a transaction.

```ocaml
val get : 'a Loc.t -> 'a t
```

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

### OCaml Kcas_data Hashtbl Create Function

Source: https://ocaml-multicore.github.io/kcas/0.3.1/kcas_data/Kcas_data/Hashtbl/index

Creates a new empty hash table with optional parameters for hashing, minimum/maximum buckets, and n-way concurrency. The default hash uses randomized bits, and the default equal is (=).

```ocaml
val create :    ?hashed_type:'k hashed_type ->   ?min_buckets:int ->   ?max_buckets:int ->   ?n_way:int ->   unit ->   ('k, 'v) t
```

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

### OCaml Kcas_data Hashtbl Create Function

Source: https://ocaml-multicore.github.io/kcas/0.5.3/kcas_data/Kcas_data/Hashtbl/index

Creates a new empty hash table with optional parameters for hashing, minimum/maximum buckets, and n-way concurrency. The default hash uses randomized bits, and the default equal is (=).

```ocaml
val create :    ?hashed_type:'k hashed_type ->   ?min_buckets:int ->   ?max_buckets:int ->   ?n_way:int ->   unit ->   ('k, 'v) t
```

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

### Kcas.Backoff: Get Current Wait Log

Source: https://ocaml-multicore.github.io/kcas/0.2.4/kcas/Kcas/Backoff/index

Retrieves the logarithm of the maximum wait time for the next `once` operation.

```ocaml
val get_wait_log : t -> int
```

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

### OCaml Kcas_data Hashtbl Create From Sequence

Source: https://ocaml-multicore.github.io/kcas/0.6.1/kcas_data/Kcas_data/Hashtbl/index

Creates a new hash table from a sequence of key-value pairs. It uses `replace` internally, so later pairs with the same key overwrite earlier ones. Optional arguments from `create` can also be provided.

```ocaml
val of_seq :    ?hashed_type:'k hashed_type ->   ?min_buckets:int ->   ?max_buckets:int ->   ?n_way:int ->   ('k * 'v) Stdlib.Seq.t ->   ('k, 'v) t
```
Tokens:
Raw