sgrust 0.8.6

A sparse grid library written in Rust.
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194

use crate::{const_generic::{algorithms::sweep::SweepFunction, iterators::grid_iterator::{GridIteratorT, HashMapGridIterator}, storage::SparseGridData}, errors::SGError};


pub trait HierarchisationOperation<const D: usize, const DIM_OUT: usize> : Copy
{
    fn hierarchize(&self, node_values: &mut [[f64; DIM_OUT]], storage: &SparseGridData<D>) -> Result<(), SGError>; 
    fn dehierarchize(&self, alpha: &mut [[f64; DIM_OUT]], storage: &SparseGridData<D>) -> Result<(), SGError>; 
}

pub struct LinearHierarchisation<const D: usize, const DIM_OUT: usize>;
impl<const D: usize, const DIM_OUT: usize> LinearHierarchisation<D, DIM_OUT>
{
    fn recurse(values: &mut [[f64; DIM_OUT]], iterator: &mut HashMapGridIterator<D>, dimension: usize, left_value: [f64; DIM_OUT], right_value: [f64; DIM_OUT])
    {
        if let Some(seq) = iterator.seq()
        {
            let mid_value = values[seq];
            if !iterator.is_leaf()
            {            
                iterator.left_child(dimension);
                if let Some(_seq) = iterator.seq()
                {                    
                    Self::recurse(values, iterator, dimension, left_value, mid_value);                    
                }
                iterator.step_right(dimension);
                if let Some(_seq) = iterator.seq()                
                {
                    Self::recurse(values, iterator, dimension, mid_value, right_value);
                }
                iterator.up(dimension);
            }
            for i in 0..DIM_OUT
            {
                values[seq][i] = mid_value[i] - 0.5 * (left_value[i] + right_value[i]);
            }
        }
    }
}

impl< const D: usize, const DIM_OUT: usize> SweepFunction<D, [f64; D], [f64; DIM_OUT]> for LinearHierarchisation<D, DIM_OUT>
{
    fn execute_in_place(&mut self, values: &mut [[f64; DIM_OUT]], iterator: &mut HashMapGridIterator<D>, _storage: &SparseGridData<D>, dimension: usize) -> Result<(), SGError>{
        Self::recurse(values, iterator, dimension, [0.0; DIM_OUT], [0.0; DIM_OUT]);
        Ok(())
    }
}


pub struct LinearBoundaryHierarchisation<const D: usize, const DIM_OUT: usize>(LinearHierarchisation<D, DIM_OUT>);

impl<const D: usize, const DIM_OUT: usize> SweepFunction<D, [f64; D], [f64; DIM_OUT]> for LinearBoundaryHierarchisation<D, DIM_OUT>
{
    #[inline]
    fn execute_in_place(&mut self, values: &mut [[f64; DIM_OUT]], iterator: &mut crate::const_generic::iterators::grid_iterator::HashMapGridIterator<D>, _storage: &SparseGridData<D>, dimension: usize) -> Result<(), SGError> {
        // left boundary
        iterator.reset_to_left_level_zero(dimension);
        let seq_left = iterator.seq().ok_or(SGError::InvalidIteratorSequence)?;
        let left_boundary = values[seq_left];
        iterator.reset_to_right_level_zero(dimension);
        let seq_right = iterator.seq().ok_or(SGError::InvalidIteratorSequence)?;       
        let right_boundary = values[seq_right];
        if !iterator.is_leaf()
        {
            iterator.reset_to_level_one(dimension);
            if iterator.seq().is_some()
            {
                LinearHierarchisation::recurse(values, iterator, dimension, left_boundary, right_boundary);
            }
            iterator.reset_to_left_level_zero(dimension);
        }
        Ok(())
    }
}

pub struct LinearDehierarchisation<const D: usize, const DIM_OUT: usize>;

impl<const D: usize, const DIM_OUT: usize> LinearDehierarchisation<D, DIM_OUT>
{
    #[inline]
    fn recurse(values: &mut [[f64; DIM_OUT]], iterator: &mut HashMapGridIterator<D>, dimension: usize, left_value: [f64; DIM_OUT], right_value: [f64; DIM_OUT])
    {
        if let Some(seq) = iterator.seq()
        {
            let mut mid_value = values[seq];
            for i in 0..DIM_OUT
            {
                mid_value[i] += (left_value[i] + right_value[i]) * 0.5;
            }
            values[seq] = mid_value;
            if !iterator.is_leaf()
            {
                iterator.left_child(dimension);
                if iterator.seq().is_some()
                {
                    Self::recurse(values, iterator, dimension, left_value, mid_value);
                }
                iterator.step_right(dimension);
                if iterator.seq().is_some()
                {
                    Self::recurse(values, iterator, dimension, mid_value, right_value);
                }
                iterator.up(dimension);
            }
        }
    }
}
impl<const D: usize, const DIM_OUT: usize> SweepFunction<D, [f64; D], [f64; DIM_OUT]> for LinearDehierarchisation<D, DIM_OUT>
{
    #[inline]
    fn execute_in_place(&mut self, values: &mut [[f64; DIM_OUT]], iterator: &mut HashMapGridIterator<D>, _storage: &SparseGridData<D>, dimension: usize) -> Result<(), SGError>{
        Self::recurse(values, iterator, dimension, [0.0; DIM_OUT], [0.0; DIM_OUT]);
        Ok(())
    }
}

pub struct LinearBoundaryDehierarchisation<const D: usize, const DIM_OUT: usize>(LinearDehierarchisation<D, DIM_OUT>);

impl<const D: usize, const DIM_OUT: usize> SweepFunction<D, [f64; D], [f64; DIM_OUT]> for LinearBoundaryDehierarchisation<D, DIM_OUT>
{
    #[inline]
    fn execute_in_place(&mut self, values: &mut [[f64; DIM_OUT]], iterator: &mut crate::const_generic::iterators::grid_iterator::HashMapGridIterator<D>, _storage: &SparseGridData<D>, dimension: usize) -> Result<(), SGError> {
        // left boundary
        iterator.reset_to_left_level_zero(dimension);
        let seq_left = iterator.seq().ok_or(SGError::InvalidIteratorSequence)?;
        let left_boundary = values[seq_left];
        iterator.reset_to_right_level_zero(dimension);
        let seq_right = iterator.seq().ok_or(SGError::InvalidIteratorSequence)?;
        let right_boundary = values[seq_right];
        if !iterator.is_leaf()
        {
            iterator.reset_to_level_one(dimension);
            if iterator.seq().is_some()
            {
               LinearDehierarchisation::recurse(values, iterator, dimension, left_boundary, right_boundary);
            }
            iterator.reset_to_left_level_zero(dimension);
        }
        Ok(())
    }
}

#[derive(Clone, Copy)]
pub struct LinearHierarchisationOperation<const D: usize, const DIM_OUT: usize>;

impl<const D: usize, const DIM_OUT: usize> HierarchisationOperation<D, DIM_OUT> for LinearHierarchisationOperation<D, DIM_OUT>
{        
    #[inline]
    fn hierarchize(&self, node_values: &mut [[f64; DIM_OUT]], storage: &SparseGridData<D>) -> Result<(), SGError>{
        use crate::const_generic::algorithms::sweep;
        let mut func = LinearHierarchisation;
        for d in 0..D
        {
            sweep::sweep_1d_in_place(&mut func, storage, node_values, d);
        }
        Ok(())
    }
    #[inline]
    fn dehierarchize(&self, alpha: &mut [[f64; DIM_OUT]], storage: &SparseGridData<D>) -> Result<(), SGError>{
        use crate::const_generic::algorithms::sweep;
        let mut func = LinearDehierarchisation;
        for d in 0..D
        {
            sweep::sweep_1d_in_place(&mut func, storage, alpha, d);
        }
        Ok(())
    }
}

#[derive(Clone, Copy)]
pub struct LinearBoundaryHierarchisationOperation<const D: usize, const DIM_OUT: usize>;

impl<const D: usize, const DIM_OUT: usize> HierarchisationOperation<D, DIM_OUT> for LinearBoundaryHierarchisationOperation<D, DIM_OUT>
{    
    #[inline]
    fn hierarchize(&self, node_values: &mut [[f64; DIM_OUT]], storage: &SparseGridData<D>) -> Result<(), SGError> {
        use crate::const_generic::algorithms::sweep;
        let mut func = LinearBoundaryHierarchisation(LinearHierarchisation);
        for d in 0..D
        {
            sweep::sweep_1d_boundary_in_place(&mut func, storage, node_values, d)?;
        }
        Ok(())
    }
    #[inline]
    fn dehierarchize(&self, alpha: &mut [[f64; DIM_OUT]], storage: &SparseGridData<D>) -> Result<(), SGError> {
        use crate::const_generic::algorithms::sweep;
        let mut func = LinearDehierarchisation;
        for d in 0..D
        {
            sweep::sweep_1d_in_place(&mut func, storage, alpha, d);
        }
        Ok(())
    }
}