brk_computer 0.3.0-alpha.3

A Bitcoin dataset computer built on top of brk_indexer
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

use brk_error::Result;
use brk_traversable::Traversable;
use brk_types::{Height, StoredF32, Version};
use derive_more::{Deref, DerefMut};
use vecdb::{
    BinaryTransform, Database, Exit, ReadableCloneableVec, ReadableVec, Rw, StorageMode, VecValue,
};

use crate::{
    indexes,
    internal::{BpsType, Percent, algo::ComputeDrawdown},
};

use crate::internal::{LazyPerBlock, PerBlock};

/// Basis-point storage with both ratio and percentage float views.
///
/// Stores integer basis points on disk (Pco-compressed),
/// exposes two lazy StoredF32 views:
/// - `ratio`: bps / 10000 (e.g., 4523 bps -> 0.4523)
/// - `percent`: bps / 100 (e.g., 4523 bps -> 45.23%)
#[derive(Deref, DerefMut, Traversable)]
#[traversable(transparent)]
pub struct PercentPerBlock<B: BpsType, M: StorageMode = Rw>(
    pub Percent<PerBlock<B, M>, LazyPerBlock<StoredF32, B>>,
);

impl<B: BpsType> PercentPerBlock<B> {
    pub(crate) fn forced_import(
        db: &Database,
        name: &str,
        version: Version,
        indexes: &indexes::Vecs,
    ) -> Result<Self> {
        let bps = PerBlock::forced_import(db, &format!("{name}_bps"), version, indexes)?;
        let bps_clone = bps.height.read_only_boxed_clone();

        let ratio = LazyPerBlock::from_computed::<B::ToRatio>(
            &format!("{name}_ratio"),
            version,
            bps_clone.clone(),
            &bps,
        );

        let percent = LazyPerBlock::from_computed::<B::ToPercent>(name, version, bps_clone, &bps);

        Ok(Self(Percent {
            bps,
            ratio,
            percent,
        }))
    }

    pub(crate) fn compute_binary<S1T, S2T, F>(
        &mut self,
        max_from: Height,
        source1: &impl ReadableVec<Height, S1T>,
        source2: &impl ReadableVec<Height, S2T>,
        exit: &Exit,
    ) -> Result<()>
    where
        S1T: VecValue,
        S2T: VecValue,
        F: BinaryTransform<S1T, S2T, B>,
    {
        self.bps
            .compute_binary::<S1T, S2T, F>(max_from, source1, source2, exit)
    }

    pub(crate) fn compute_drawdown<C, A>(
        &mut self,
        max_from: Height,
        current: &impl ReadableVec<Height, C>,
        ath: &impl ReadableVec<Height, A>,
        exit: &Exit,
    ) -> Result<()>
    where
        C: VecValue,
        A: VecValue,
        f64: From<C> + From<A>,
        vecdb::EagerVec<vecdb::PcoVec<Height, B>>: ComputeDrawdown<Height>,
    {
        self.bps
            .height
            .compute_drawdown(max_from, current, ath, exit)
    }
}