hnsw_rs

https://docs.rs/hnsw_rs/0.3.2/
Admin
hnsw_rs is a Rust implementation of Hierarchical Navigable Small World graphs for efficient...
Tokens:709,567
Snippets:2,929
Trust Score:9.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Rust Ecosystem Links

Source: https://docs.rs/hnsw_rs/0.3.2/hnsw_rs/filter/index

Provides links to relevant resources within the Rust ecosystem, including the official Rust website, The Book, Standard Library API Reference, Rust by Example, and the Cargo Guide.

```Rust
Rust Website: https://www.rust-lang.org/
The Book: https://doc.rust-lang.org/book/
Standard Library API Reference: https://doc.rust-lang.org/std/
Rust by Example: https://doc.rust-lang.org/rust-by-example/
The Cargo Guide: https://doc.rust-lang.org/cargo/guide/
Clippy Documentation: https://doc.rust-lang.org/nightly/clippy
```

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

### hnsw_rs Prelude Overview

Source: https://docs.rs/hnsw_rs/0.3.2/hnsw_rs/prelude/struct.NoDist

An overview of the `hnsw_rs::prelude` module, listing available structs, constants, traits, and functions. This provides a quick reference to the core components of the library.

```APIDOC
Structs:
  DistCFFI
  DistCosine
  DistDot
  DistFn
  DistHamming
  DistHellinger
  DistJaccard
  DistJeffreys
  DistJensenShannon
  DistL1
  DistL2
  DistLevenshtein
  DistPtr
  NoDist

Constants:
  M_MIN

Traits:
  Distance

Functions:
  l2_normalize
```

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

### DescriptionFFI Methods

Source: https://docs.rs/hnsw_rs/0.3.2/hnsw_rs/libext/struct.DescriptionFFI

This section details the methods available for the `DescriptionFFI` struct in the `hnsw_rs::libext` module. It includes information on how to construct and interact with `DescriptionFFI` instances.

```APIDOC
DescriptionFFI Methods:
  - new(): Creates a new instance of the DescriptionFFI struct. This is likely a constructor for initializing the HNSW graph description.
```

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

### Problematic Pin Implementation Example

Source: https://docs.rs/hnsw_rs/0.3.2/hnsw_rs/hnsw/type.PointDistance

Illustrates a problematic `From<Box<T>> for Pin<T>` implementation that can lead to ambiguity when calling `Pin::from`. This example is intended to show a poor practice and deliberately fails to compile.

```rust
struct Foo;
impl From<Box<()>> for Pin<Foo> {
    fn from(_: Box<()>) -> Pin<Foo> {
        Pin::new(Foo)
    }
}

let foo = Box::new(());
let bar = Pin::from(foo);
```

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

### DumpInit Methods

Source: https://docs.rs/hnsw_rs/0.3.2/hnsw_rs/hnswio/struct.DumpInit

This section details the methods available for the DumpInit struct in the hnsw_rs crate. These methods are used for managing the initialization and state of HNSW graph dumps.

```APIDOC
DumpInit:
  flush()
    Flushes any buffered data to the underlying storage.

  get_basename() -> String
    Returns the base name used for dump files.

  new(path: &str, hnsw_filename: &str) -> DumpInit
    Creates a new DumpInit instance for managing HNSW graph dumps.
    Parameters:
      path: The directory path where dump files will be stored.
      hnsw_filename: The base filename for the HNSW graph data.
```

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

### Point::get_v - Get Vector Data

Source: https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/hnsw.rs

Retrieves a slice reference to the vector data stored within the Point.

```rust
pub fn get_v(&self) -> &[T] {
    self.data.get_v()
}
```

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

### Get Data Type Name

Source: https://docs.rs/hnsw_rs/0.3.2/hnsw_rs/datamap/struct.DataMap

Returns the full name of the data type stored in the DataMap as a String.

```rust
pub fn get_data_typename(&self) -> String
```

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

### hnsw_rs Crate Overview

Source: https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/prelude.rs

Provides an overview of the hnsw_rs crate, including its purpose, license, source code links, and dependencies. It also lists the supported platforms and the percentage of documented code.

```Rust
Project: /context7/hnsw_rs_rs-0.3.2

Dependencies:
  anndists ^0.1
  anyhow ^1.0
  bincode ^1.3
  cfg-if ^1.0
  cpu-time ^1.0
  env_logger ^0.11
  hashbrown ^0.15
  indexmap ^2.9
  lazy_static ^1.4
  log ^0.4
  mmap-rs ^0.6
  num-traits ^0.2
  num_cpus ^1.16
  parking_lot ^0.12
  rand ^0.9
  rayon ^1.10
  serde ^1.0
  hdf5-metno ^0.10.0 (dev)
  ndarray ^0.16 (dev)
  skiplist ^0.6 (dev)
  tempfile ^3 (dev)

Platforms:
  i686-pc-windows-msvc
  i86-unknown-linux-gnu
  x86_64-apple-darwin
  x86_64-pc-windows-msvc
  x86_64-unknown-linux-gnu

Documentation Coverage: 76.32%
```

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

### Get nth Iterator Element

Source: https://docs.rs/hnsw_rs/0.3.2/hnsw_rs/hnsw/type.PointDistance

Retrieves the nth element from an iterator. This method consumes the iterator up to the nth element.

```rust
fn nth(&mut self, n: usize) -> Option<Self::Item>
```

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

### hnsw_rs Library Initialization and Modules

Source: https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/lib.rs

This snippet shows the main initialization logic for the hnsw_rs library, including setting up the logger and re-exporting modules. It demonstrates the use of `lazy_static` for one-time initialization of the logger and imports various sub-modules.

```rust
#![cfg_attr(feature = "stdsimd", feature(portable_simd))]
use env_logger::Builder;
use lazy_static::lazy_static;

pub mod api;
pub mod datamap;
pub mod filter;
pub mod hnsw;
pub mod hnswio;
pub mod libext;
pub mod prelude;

pub use anndists;

lazy_static! {
    static ref LOG: u64 = init_log();
}

// install a logger facility
fn init_log() -> u64 {
    Builder::from_default_env().init();
    println!("\n ************** initializing logger *****************\n");
    1
}
```

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

### hnsw_rs Crate Overview

Source: https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/hnswio.rs

Provides an overview of the hnsw_rs crate, including its purpose, license, source code links, and dependencies. It also lists supported platforms and documentation completeness.

```rust
Project: /context7/rs-hnsw_rs-0.3.2
Content:
[ Docs.rs ](https://docs.rs/)
  * [ hnsw_rs-0.3.2 ](https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/hnswio.rs.html "Ann based on Hierarchical Navigable Small World Graphs from Yu.A. Malkov and D.A Yashunin")
    * hnsw_rs 0.3.2 
    * [ ](https://docs.rs/crate/hnsw_rs/0.3.2 "See hnsw_rs in docs.rs")
    * [MIT](https://spdx.org/licenses/MIT)/[Apache-2.0](https://spdx.org/licenses/Apache-2.0)
    * Links
    * [ ](https://github.com/jean-pierreBoth/hnswlib-rs)
    * [ ](https://crates.io/crates/hnsw_rs "See hnsw_rs in crates.io")
    * [ ](https://docs.rs/crate/hnsw_rs/0.3.2/source/ "Browse source of hnsw_rs-0.3.2")
    * Owners
    * [ ](https://crates.io/users/jean-pierreBoth)
    * Dependencies
    *       * [ anndists ^0.1 _normal_ ](https://docs.rs/anndists/^0.1)
      * [ anyhow ^1.0 _normal_ ](https://docs.rs/anyhow/^1.0)
      * [ bincode ^1.3 _normal_ ](https://docs.rs/bincode/^1.3)
      * [ cfg-if ^1.0 _normal_ ](https://docs.rs/cfg-if/^1.0)
      * [ cpu-time ^1.0 _normal_ ](https://docs.rs/cpu-time/^1.0)
      * [ env_logger ^0.11 _normal_ ](https://docs.rs/env_logger/^0.11)
      * [ hashbrown ^0.15 _normal_ ](https://docs.rs/hashbrown/^0.15)
      * [ indexmap ^2.9 _normal_ ](https://docs.rs/indexmap/^2.9)
      * [ lazy_static ^1.4 _normal_ ](https://docs.rs/lazy_static/^1.4)
      * [ log ^0.4 _normal_ ](https://docs.rs/log/^0.4)
      * [ mmap-rs ^0.6 _normal_ ](https://docs.rs/mmap-rs/^0.6)
      * [ num-traits ^0.2 _normal_ ](https://docs.rs/num-traits/^0.2)
      * [ num_cpus ^1.16 _normal_ ](https://docs.rs/num_cpus/^1.16)
      * [ parking_lot ^0.12 _normal_ ](https://docs.rs/parking_lot/^0.12)
      * [ rand ^0.9 _normal_ ](https://docs.rs/rand/^0.9)
      * [ rayon ^1.10 _normal_ ](https://docs.rs/rayon/^1.10)
      * [ serde ^1.0 _normal_ ](https://docs.rs/serde/^1.0)
      * [ hdf5-metno ^0.10.0 _dev_ ](https://docs.rs/hdf5-metno/^0.10.0)
      * [ ndarray ^0.16 _dev_ ](https://docs.rs/ndarray/^0.16)
      * [ skiplist ^0.6 _dev_ ](https://docs.rs/skiplist/^0.6)
      * [ tempfile ^3 _dev_ ](https://docs.rs/tempfile/^3)
    * Versions
    * [ **76.32%** of the crate is documented ](https://docs.rs/crate/hnsw_rs/0.3.2)
  * [ Platform ](https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/hnswio.rs.html)
    * [i686-pc-windows-msvc](https://docs.rs/crate/hnsw_rs/0.3.2/target-redirect/i686-pc-windows-msvc/src/hnsw_rs/hnswio.rs.html)
    * [i686-unknown-linux-gnu](https://docs.rs/crate/hnsw_rs/0.3.2/target-redirect/i686-unknown-linux-gnu/src/hnsw_rs/hnswio.rs.html)
    * [x86_64-apple-darwin](https://docs.rs/crate/hnsw_rs/0.3.2/target-redirect/x86_64-apple-darwin/src/hnsw_rs/hnswio.rs.html)
    * [x86_64-pc-windows-msvc](https://docs.rs/crate/hnsw_rs/0.3.2/target-redirect/x86_64-pc-windows-msvc/src/hnsw_rs/hnswio.rs.html)
    * [x86_64-unknown-linux-gnu](https://docs.rs/crate/hnsw_rs/0.3.2/target-redirect/x86_64-unknown-linux-gnu/src/hnsw_rs/hnswio.rs.html)
  * [ Feature flags ](https://docs.rs/crate/hnsw_rs/0.3.2/features "Browse available feature flags of hnsw_rs-0.3.2")


  * [docs.rs](https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/hnswio.rs.html)
    * [](https://docs.rs/about)
    * [](https://docs.rs/about/badges)
    * [](https://docs.rs/about/builds)
    * [](https://docs.rs/about/metadata)
    * [](https://docs.rs/about/redirections)
    * [](https://docs.rs/about/download)
    * [](https://docs.rs/about/rustdoc-json)
    * [](https://docs.rs/releases/queue)
    * [](https://foundation.rust-lang.org/policies/privacy-policy/#docs.rs)


  * [Rust](https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/hnswio.rs.html)
    * [Rust website](https://www.rust-lang.org/)
    * [The Book](https://doc.rust-lang.org/book/)
    * [Standard Library API Reference](https://doc.rust-lang.org/std/)
    * [Rust by Example](https://doc.rust-lang.org/rust-by-example/)
    * [The Cargo Guide](https://doc.rust-lang.org/cargo/guide/)
    * [Clippy Documentation](https://doc.rust-lang.org/nightly/clippy)


## Files
hnsw_rs
[api.rs](https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/api.rs.html)[datamap.rs](https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/datamap.rs.html)[filter.rs](https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/filter.rs.html)[flatten.rs](https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/flatten.rs.html)[hnsw.rs](https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/hnsw.rs.html)[hnswio.rs](https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/hnswio.rs.html)[lib.rs](https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/lib.rs.html)[libext.rs](https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/libext.rs.html)[prelude.rs](https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/prelude.rs.html)
[](https://docs.rs/hnsw_rs/0.3.2/hnsw_rs/all.html "show sidebar")
```

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

### Get Last Iterator Element

Source: https://docs.rs/hnsw_rs/0.3.2/hnsw_rs/hnsw/type.PointDistance

Consumes the iterator and returns the last element. If the iterator is empty, it returns None.

```rust
fn last(self) -> Option<Self::Item>
```

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

### HnswIo::get_basename - Get Basename

Source: https://docs.rs/hnsw_rs/0.3.2/hnsw_rs/hnswio/struct.HnswIo

Retrieves the basename associated with the HnswIo instance, which is used for constructing the dump file names.

```APIDOC
pub fn get_basename(&self) -> &[str]
return basename of dump
```

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

### hnsw_rs Crate Overview

Source: https://docs.rs/hnsw_rs/0.3.2/hnsw_rs/libext/index

Provides an overview of the hnsw_rs crate, including its purpose, license, source code links, and dependencies. It also indicates the percentage of documented code.

```rust
Crate: hnsw_rs
Version: 0.3.2
Description: Ann based on Hierarchical Navigable Small World Graphs from Yu.A. Malkov and D.A Yashunin
License: MIT / Apache-2.0
Repository: https://github.com/jean-pierreBoth/hnswlib-rs
Documentation: https://docs.rs/hnsw_rs/0.3.2/hnsw_rs/
Dependencies:
  - anndists ^0.1
  - anyhow ^1.0
  - bincode ^1.3
  - cfg-if ^1.0
  - cpu-time ^1.0
  - env_logger ^0.11
  - hashbrown ^0.15
  - indexmap ^2.9
  - lazy_static ^1.4
  - log ^0.4
  - mmap-rs ^0.6
  - num-traits ^0.2
  - num_cpus ^1.16
  - parking_lot ^0.12
  - rand ^0.9
  - rayon ^1.10
  - serde ^1.0
Dev Dependencies:
  - hdf5-metno ^0.10.0
  - ndarray ^0.16
  - skiplist ^0.6
  - tempfile ^3
Documentation Coverage: 76.32%
```

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

### hnsw_rs Crate Information

Source: https://docs.rs/hnsw_rs/0.3.2/hnsw_rs/libext/fn.init_rust_log

Provides an overview of the hnsw_rs crate, including its version, license, source code repository, and dependencies. It also indicates the percentage of the crate that is documented.

```Rust
Crate: hnsw_rs
Version: 0.3.2
License: MIT/Apache-2.0
Repository: https://github.com/jean-pierreBoth/hnswlib-rs
Dependencies:
  - anndists ^0.1
  - anyhow ^1.0
  - bincode ^1.3
  - cfg-if ^1.0
  - cpu-time ^1.0
  - env_logger ^0.11
  - hashbrown ^0.15
  - indexmap ^2.9
  - lazy_static ^1.4
  - log ^0.4
  - mmap-rs ^0.6
  - num-traits ^0.2
  - num_cpus ^1.16
  - parking_lot ^0.12
  - rand ^0.9
  - rayon ^1.10
  - serde ^1.0
  - hdf5-metno ^0.10.0 (dev)
  - ndarray ^0.16 (dev)
  - skiplist ^0.6 (dev)
  - tempfile ^3 (dev)
Documentation Coverage: 76.32%
```

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

### Get Number of Data Points

Source: https://docs.rs/hnsw_rs/0.3.2/hnsw_rs/datamap/struct.DataMap

Returns the total number of data points stored in the memory-mapped region of the DataMap.

```rust
pub fn get_nb_data(&self) -> usize
```

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

### Get Distance Metric Name

Source: https://docs.rs/hnsw_rs/0.3.2/hnsw_rs/datamap/struct.DataMap

Returns the full name of the distance metric used by the HNSW index as a String.

```rust
pub fn get_distname(&self) -> String
```

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

### hnsw_rs Crate Overview

Source: https://docs.rs/hnsw_rs/0.3.2/hnsw_rs/datamap/index

Provides an overview of the hnsw_rs crate, including its version, license, source code links, and dependencies. It also indicates the percentage of documented code.

```Rust
Project: /context7/hnsw_rs_rs-0.3.2

[Docs.rs](https://docs.rs/)
  * [hnsw_rs-0.3.2](https://docs.rs/hnsw_rs/0.3.2/hnsw_rs/datamap/index.html "Ann based on Hierarchical Navigable Small World Graphs from Yu.A. Malkov and D.A Yashunin")
    * hnsw_rs 0.3.2 
    * [ ](https://docs.rs/crate/hnsw_rs/0.3.2 "See hnsw_rs in docs.rs")
    * [MIT](https://spdx.org/licenses/MIT)/[Apache-2.0](https://spdx.org/licenses/Apache-2.0)
    * Links
    * [ ](https://github.com/jean-pierreBoth/hnswlib-rs)
    * [ ](https://crates.io/crates/hnsw_rs "See hnsw_rs in crates.io")
    * [ ](https://docs.rs/crate/hnsw_rs/0.3.2/source/ "Browse source of hnsw_rs-0.3.2")
    * Owners
    * [ ](https://crates.io/users/jean-pierreBoth)
    * Dependencies
    *       * [ anndists ^0.1 _normal_ ](https://docs.rs/anndists/^0.1)
      * [ anyhow ^1.0 _normal_ ](https://docs.rs/anyhow/^1.0)
      * [ bincode ^1.3 _normal_ ](https://docs.rs/bincode/^1.3)
      * [ cfg-if ^1.0 _normal_ ](https://docs.rs/cfg-if/^1.0)
      * [ cpu-time ^1.0 _normal_ ](https://docs.rs/cpu-time/^1.0)
      * [ env_logger ^0.11 _normal_ ](https://docs.rs/env_logger/^0.11)
      * [ hashbrown ^0.15 _normal_ ](https://docs.rs/hashbrown/^0.15)
      * [ indexmap ^2.9 _normal_ ](https://docs.rs/indexmap/^2.9)
      * [ lazy_static ^1.4 _normal_ ](https://docs.rs/lazy_static/^1.4)
      * [ log ^0.4 _normal_ ](https://docs.rs/log/^0.4)
      * [ mmap-rs ^0.6 _normal_ ](https://docs.rs/mmap-rs/^0.6)
      * [ num-traits ^0.2 _normal_ ](https://docs.rs/num-traits/^0.2)
      * [ num_cpus ^1.16 _normal_ ](https://docs.rs/num_cpus/^1.16)
      * [ parking_lot ^0.12 _normal_ ](https://docs.rs/parking_lot/^0.12)
      * [ rand ^0.9 _normal_ ](https://docs.rs/rand/^0.9)
      * [ rayon ^1.10 _normal_ ](https://docs.rs/rayon/^1.10)
      * [ serde ^1.0 _normal_ ](https://docs.rs/serde/^1.0)
      * [ hdf5-metno ^0.10.0 _dev_ ](https://docs.rs/hdf5-metno/^0.10.0)
      * [ ndarray ^0.16 _dev_ ](https://docs.rs/ndarray/^0.16)
      * [ skiplist ^0.6 _dev_ ](https://docs.rs/skiplist/^0.6)
      * [ tempfile ^3 _dev_ ](https://docs.rs/tempfile/^3)
    * Versions
    * [ **76.32%** of the crate is documented ](https://docs.rs/crate/hnsw_rs/0.3.2)
  * [ Platform ](https://docs.rs/hnsw_rs/0.3.2/hnsw_rs/datamap/index.html)
    * [i686-pc-windows-msvc](https://docs.rs/crate/hnsw_rs/0.3.2/target-redirect/i686-pc-windows-msvc/hnsw_rs/datamap/index.html)
    * [i686-unknown-linux-gnu](https://docs.rs/crate/hnsw_rs/0.3.2/target-redirect/i686-unknown-linux-gnu/hnsw_rs/datamap/index.html)
    * [x86_64-apple-darwin](https://docs.rs/crate/hnsw_rs/0.3.2/target-redirect/x86_64-apple-darwin/hnsw_rs/datamap/index.html)
    * [x86_64-pc-windows-msvc](https://docs.rs/crate/hnsw_rs/0.3.2/target-redirect/x86_64-pc-windows-msvc/hnsw_rs/datamap/index.html)
    * [x86_64-unknown-linux-gnu](https://docs.rs/crate/hnsw_rs/0.3.2/target-redirect/x86_64-unknown-linux-gnu/hnsw_rs/datamap/index.html)
  * [ Feature flags ](https://docs.rs/crate/hnsw_rs/0.3.2/features "Browse available feature flags of hnsw_rs-0.3.2")
```

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

### Rust enumerate Iterator

Source: https://docs.rs/hnsw_rs/0.3.2/hnsw_rs/hnsw/struct.IterPoint

Creates an iterator that yields pairs of the current iteration count (starting from zero) and the element.

```rust
fn enumerate(self) -> Enumerate<Self>
where
    Self: Sized,
```

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

### HnswApii32 Struct and Methods

Source: https://docs.rs/hnsw_rs/0.3.2/hnsw_rs/libext/struct.HnswApii32

Documentation for the HnswApii32 struct within the hnsw_rs crate. This section details the available methods, including the constructor for creating new instances.

```APIDOC
HnswApii32:
  new()
    Creates a new instance of HnswApii32.
```

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

### hnsw_rs Crate Overview

Source: https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/libext.rs

Provides an overview of the hnsw_rs crate, including its purpose, license, source code links, and dependencies. It also indicates the percentage of documented code.

```Rust
Project: /context7/hnsw_rs_rs-0.3.2
Content:
[ Docs.rs ](https://docs.rs/)
  * [ hnsw_rs-0.3.2 ](https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/libext.rs.html "Ann based on Hierarchical Navigable Small World Graphs from Yu.A. Malkov and D.A Yashunin")
    * hnsw_rs 0.3.2 
    * [ ](https://docs.rs/crate/hnsw_rs/0.3.2 "See hnsw_rs in docs.rs")
    * [MIT](https://spdx.org/licenses/MIT)/[Apache-2.0](https://spdx.org/licenses/Apache-2.0)
    * Links
    * [ ](https://github.com/jean-pierreBoth/hnswlib-rs)
    * [ ](https://crates.io/crates/hnsw_rs "See hnsw_rs in crates.io")
    * [ ](https://docs.rs/crate/hnsw_rs/0.3.2/source/ "Browse source of hnsw_rs-0.3.2")
    * Owners
    * [ ](https://crates.io/users/jean-pierreBoth)
    * Dependencies
    *       * [ anndists ^0.1 _normal_ ](https://docs.rs/anndists/^0.1)
      * [ anyhow ^1.0 _normal_ ](https://docs.rs/anyhow/^1.0)
      * [ bincode ^1.3 _normal_ ](https://docs.rs/bincode/^1.3)
      * [ cfg-if ^1.0 _normal_ ](https://docs.rs/cfg-if/^1.0)
      * [ cpu-time ^1.0 _normal_ ](https://docs.rs/cpu-time/^1.0)
      * [ env_logger ^0.11 _normal_ ](https://docs.rs/env_logger/^0.11)
      * [ hashbrown ^0.15 _normal_ ](https://docs.rs/hashbrown/^0.15)
      * [ indexmap ^2.9 _normal_ ](https://docs.rs/indexmap/^2.9)
      * [ lazy_static ^1.4 _normal_ ](https://docs.rs/lazy_static/^1.4)
      * [ log ^0.4 _normal_ ](https://docs.rs/log/^0.4)
      * [ mmap-rs ^0.6 _normal_ ](https://docs.rs/mmap-rs/^0.6)
      * [ num-traits ^0.2 _normal_ ](https://docs.rs/num-traits/^0.2)
      * [ num_cpus ^1.16 _normal_ ](https://docs.rs/num_cpus/^1.16)
      * [ parking_lot ^0.12 _normal_ ](https://docs.rs/parking_lot/^0.12)
      * [ rand ^0.9 _normal_ ](https://docs.rs/rand/^0.9)
      * [ rayon ^1.10 _normal_ ](https://docs.rs/rayon/^1.10)
      * [ serde ^1.0 _normal_ ](https://docs.rs/serde/^1.0)
      * [ hdf5-metno ^0.10.0 _dev_ ](https://docs.rs/hdf5-metno/^0.10.0)
      * [ ndarray ^0.16 _dev_ ](https://docs.rs/ndarray/^0.16)
      * [ skiplist ^0.6 _dev_ ](https://docs.rs/skiplist/^0.6)
      * [ tempfile ^3 _dev_ ](https://docs.rs/tempfile/^3)
    * Versions
    * [ **76.32%** of the crate is documented ](https://docs.rs/crate/hnsw_rs/0.3.2)
  * [ Platform ](https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/libext.rs.html)
    * [i686-pc-windows-msvc](https://docs.rs/crate/hnsw_rs/0.3.2/target-redirect/i86-pc-windows-msvc/src/hnsw_rs/libext.rs.html)
    * [i686-unknown-linux-gnu](https://docs.rs/crate/hnsw_rs/0.3.2/target-redirect/i86-unknown-linux-gnu/src/hnsw_rs/libext.rs.html)
    * [x86_64-apple-darwin](https://docs.rs/crate/hnsw_rs/0.3.2/target-redirect/x86_64-apple-darwin/src/hnsw_rs/libext.rs.html)
    * [x86_64-pc-windows-msvc](https://docs.rs/crate/hnsw_rs/0.3.2/target-redirect/x86_64-pc-windows-msvc/src/hnsw_rs/libext.rs.html)
    * [x86_64-unknown-linux-gnu](https://docs.rs/crate/hnsw_rs/0.3.2/target-redirect/x86_64-unknown-linux-gnu/src/hnsw_rs/libext.rs.html)
  * [ Feature flags ](https://docs.rs/crate/hnsw_rs/0.3.2/features "Browse available feature flags of hnsw_rs-0.3.2")


  * [docs.rs](https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/libext.rs.html)
    * [](https://docs.rs/about)
    * [](https://docs.rs/about/badges)
    * [](https://docs.rs/about/builds)
    * [](https://docs.rs/about/metadata)
    * [](https://docs.rs/about/redirections)
    * [](https://docs.rs/about/download)
    * [](https://docs.rs/about/rustdoc-json)
    * [](https://docs.rs/releases/queue)
    * [](https://foundation.rust-lang.org/policies/privacy-policy/#docs.rs)


  * [Rust](https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/libext.rs.html)
    * [Rust website](https://www.rust-lang.org/)
    * [The Book](https://doc.rust-lang.org/book/)
    * [Standard Library API Reference](https://doc.rust-lang.org/std/)
    * [Rust by Example](https://doc.rust-lang.org/rust-by-example/)
    * [The Cargo Guide](https://doc.rust-lang.org/cargo/guide/)
    * [Clippy Documentation](https://doc.rust-lang.org/nightly/clippy)
```

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

### Box::into_inner Example

Source: https://docs.rs/hnsw_rs/0.3.2/hnsw_rs/hnsw/type.PointDistance

Shows how to consume a Box and retrieve the inner value using `Box::into_inner`. This is an experimental API.

```rust
#![feature(box_into_inner)]

let c = Box::new(5);

assert_eq!(Box::into_inner(c), 5);
```

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

### Get Max Layer Authorized

Source: https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/hnsw.rs

Returns the maximum layer that is authorized for graph construction. This parameter limits the depth of the HNSW graph.

```rust
/// returns the maximum layer authorized in construction
pub fn get_max_level(&self) -> usize {
    self.max_layer
}
```

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

### hnsw_rs Files

Source: https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/libext.rs

Lists the source files within the hnsw_rs crate, providing links to their respective documentation pages.

```Rust
## Files
hnsw_rs
[api.rs](https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/api.rs.html)[datamap.rs](https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/datamap.rs.html)[filter.rs](https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/filter.rs.html)[flatten.rs](https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/flatten.rs.html)[hnsw.rs](https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/hnsw.rs.html)[hnswio.rs](https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/hnswio.rs.html)[lib.rs](https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/lib.rs.html)[libext.rs](https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/libext.rs.html)[prelude.rs](https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/prelude.rs.html)
[](https://docs.rs/hnsw_rs/0.3.2/hnsw_rs/all.html "show sidebar")
```

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

### hnsw_rs Crate Overview

Source: https://docs.rs/hnsw_rs/0.3.2/hnsw_rs/api/index

Provides an overview of the hnsw_rs crate, including its purpose, version, license, and links to source code and dependencies. It also indicates the percentage of documented code.

```Rust
Project: /context7/hnsw_rs_rs-0.3.2
Crate: hnsw_rs 0.3.2
License: MIT/Apache-2.0
Source: https://github.com/jean-pierreBoth/hnswlib-rs
Documentation: https://docs.rs/hnsw_rs/0.3.2/hnsw_rs/
Dependencies:
  - anndists ^0.1
  - anyhow ^1.0
  - bincode ^1.3
  - cfg-if ^1.0
  - cpu-time ^1.0
  - env_logger ^0.11
  - hashbrown ^0.15
  - indexmap ^2.9
  - lazy_static ^1.4
  - log ^0.4
  - mmap-rs ^0.6
  - num-traits ^0.2
  - num_cpus ^1.16
  - parking_lot ^0.12
  - rand ^0.9
  - rayon ^1.10
  - serde ^1.0
  - hdf5-metno ^0.10.0 (dev)
  - ndarray ^0.16 (dev)
  - skiplist ^0.6 (dev)
  - tempfile ^3 (dev)
Documentation Coverage: 76.32%
```

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

### Get Origin ID

Source: https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/hnsw.rs

Retrieves the external or client-provided ID for a point. This is the identifier that users typically interact with when adding or querying points.

```rust
/// returns external (or client id) id of point
pub fn get_origin_id(&self) -> usize {
    self.origin_id
}
```

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

### hnsw_rs Crate Overview

Source: https://docs.rs/hnsw_rs/0.3.2/hnsw_rs/prelude/index

Provides an overview of the hnsw_rs crate, including its purpose, license, source code links, and dependencies. It also indicates the percentage of documented code.

```rust
Crate: hnsw_rs
Version: 0.3.2
Description: Ann based on Hierarchical Navigable Small World Graphs from Yu.A. Malkov and D.A Yashunin
License: MIT/Apache-2.0
Source: https://github.com/jean-pierreBoth/hnswlib-rs
Dependencies:
  - anndists ^0.1
  - anyhow ^1.0
  - bincode ^1.3
  - cfg-if ^1.0
  - cpu-time ^1.0
  - env_logger ^0.11
  - hashbrown ^0.15
  - indexmap ^2.9
  - lazy_static ^1.4
  - log ^0.4
  - mmap-rs ^0.6
  - num-traits ^0.2
  - num_cpus ^1.16
  - parking_lot ^0.12
  - rand ^0.9
  - rayon ^1.10
  - serde ^1.0
  - hdf5-metno ^0.10.0 (dev)
  - ndarray ^0.16 (dev)
  - skiplist ^0.6 (dev)
  - tempfile ^3 (dev)
Documentation Coverage: 76.32%
```

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

### Rust enumerate Iterator Adapter

Source: https://docs.rs/hnsw_rs/0.3.2/hnsw_rs/hnsw/struct.IterPointLayer

Creates an iterator that yields pairs of the current iteration count (starting from zero) and the element.

```rust
fn enumerate(self) -> Enumerate<Self>
where
    Self: Sized,
```

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

### hnsw_rs Crate Overview

Source: https://docs.rs/hnsw_rs/0.3.2/hnsw_rs/hnsw/index

Provides an overview of the hnsw_rs crate, including its purpose, license, source code links, and dependencies.

```rust
Crate: hnsw_rs
Version: 0.3.2
Description: Ann based on Hierarchical Navigable Small World Graphs from Yu.A. Malkov and D.A Yashunin
License: MIT / Apache-2.0
Source: https://github.com/jean-pierreBoth/hnswlib-rs
Dependencies:
  - anndists ^0.1
  - anyhow ^1.0
  - bincode ^1.3
  - cfg-if ^1.0
  - cpu-time ^1.0
  - env_logger ^0.11
  - hashbrown ^0.15
  - indexmap ^2.9
  - lazy_static ^1.4
  - log ^0.4
  - mmap-rs ^0.6
  - num-traits ^0.2
  - num_cpus ^1.16
  - parking_lot ^0.12
  - rand ^0.9
  - rayon ^1.10
  - serde ^1.0
  - hdf5-metno ^0.10.0 (dev)
  - ndarray ^0.16 (dev)
  - skiplist ^0.6 (dev)
  - tempfile ^3 (dev)
Documentation Coverage: 76.32%
```

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

### Get Datamap Option

Source: https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/hnsw.rs

Checks if the datamap option is enabled. This is relevant when dumping the HNSW structure, particularly concerning whether files are memory-mapped.

```rust
pub(crate) fn get_datamap_opt(&self) -> bool {
    self.datamap_opt
}
```

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

### hnsw_rs Crate Overview

Source: https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/hnsw.rs

This snippet provides a high-level overview of the hnsw_rs crate, including its purpose, version, license, and links to its source code and dependencies. It highlights the crate's focus on HNSW graph implementation for efficient search.

```Rust
/// Ann based on Hierarchical Navigable Small World Graphs from Yu.A. Malkov and D.A Yashunin
/// Crate: hnsw_rs
/// Version: 0.3.2
/// License: MIT / Apache-2.0
/// Repository: https://github.com/jean-pierreBoth/hnswlib-rs
/// Documentation: https://docs.rs/hnsw_rs/0.3.2/
/// Dependencies:
/// - anndists ^0.1
/// - anyhow ^1.0
/// - bincode ^1.3
/// - cfg-if ^1.0
/// - cpu-time ^1.0
/// - env_logger ^0.11
/// - hashbrown ^0.15
/// - indexmap ^2.9
/// - lazy_static ^1.4
/// - log ^0.4
/// - mmap-rs ^0.6
/// - num-traits ^0.2
/// - num_cpus ^1.16
/// - parking_lot ^0.12
/// - rand ^0.9
/// - rayon ^1.10
/// - serde ^1.0
/// - hdf5-metno ^0.10.0 (dev)
/// - ndarray ^0.16 (dev)
/// - skiplist ^0.6 (dev)
/// - tempfile ^3 (dev)

```

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

### Get ef_construction

Source: https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/hnsw.rs

Retrieves the ef_construction parameter used during the graph creation process. This value influences the trade-off between build time and search accuracy.

```rust
/// get ef_construction used in graph creation
pub fn get_ef_construction(&self) -> usize {
    self.ef_construction
}
```

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

### Get HNSW Base Name

Source: https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/hnswio.rs

Retrieves the base name of the HNSW dump file. This is a simple getter method for the basename field.

```rust
pub fn get_basename(&self) -> &str {
    &self.basename
}
```

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

### hnsw_rs Crate Information

Source: https://docs.rs/hnsw_rs/0.3.2/settings

Provides an overview of the hnsw_rs crate, including its version, license, source code links, and dependencies. It also indicates the documentation coverage percentage.

```Rust
Crate: hnsw_rs
Version: 0.3.2
License: MIT / Apache-2.0
Source: https://github.com/jean-pierreBoth/hnswlib-rs
Documentation Coverage: 76.32%
Dependencies:
  - anndists ^0.1
  - anyhow ^1.0
  - bincode ^1.3
  - cfg-if ^1.0
  - cpu-time ^1.0
  - env_logger ^0.11
  - hashbrown ^0.15
  - indexmap ^2.9
  - lazy_static ^1.4
  - log ^0.4
  - mmap-rs ^0.6
  - num-traits ^0.2
  - num_cpus ^1.16
  - parking_lot ^0.12
  - rand ^0.9
  - rayon ^1.10
  - serde ^1.0
Dev Dependencies:
  - hdf5-metno ^0.10.0
  - ndarray ^0.16
  - skiplist ^0.6
  - tempfile ^3
```

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

### Get Basename

Source: https://docs.rs/hnsw_rs/0.3.2/src/hnsw_rs/hnswio.rs

Returns the basename used for the dump. This basename might have been made unique to avoid overwriting a previous or memory-mapped dump.

```rust
pub fn get_basename(&self) -> &String {
        &self.basename
    }
```

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

### hnswio Module Overview

Source: https://docs.rs/hnsw_rs/0.3.2/hnsw_rs/hnswio/struct.DumpInit

An overview of the hnswio module within the hnsw_rs crate, listing its primary components including structs (Description, DumpInit, HnswIo, ReloadOptions) and enums (DumpMode), along with the load_description function.

```rust
/// Structs
/// Description
/// DumpInit
/// HnswIo
/// ReloadOptions

/// Enums
/// DumpMode

/// Functions
/// load_description
```
Tokens:
Raw