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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
/*
 * File: sdp.rs
 * Project: matrix
 * Created Date: 28/05/2021
 * Author: Shun Suzuki
 * -----
 * Last Modified: 23/11/2023
 * Modified By: Shun Suzuki (suzuki@hapis.k.u-tokyo.ac.jp)
 * -----
 * Copyright (c) 2021 Shun Suzuki. All rights reserved.
 *
 */

use std::{collections::HashMap, rc::Rc};

use rand::Rng;

use crate::{
    constraint::EmissionConstraint, helper::generate_result, impl_holo, Amplitude, Complex,
    LinAlgBackend, Trans,
};
use autd3_derive::Gain;

use autd3_driver::{
    defined::T4010A1_AMPLITUDE,
    derive::prelude::*,
    geometry::{Geometry, Vector3},
};

/// Gain to produce multiple foci by solving Semi-Denfinite Programming
///
/// Reference
/// * Inoue, Seki, Yasutoshi Makino, and Hiroyuki Shinoda. "Active touch perception produced by airborne ultrasonic haptic hologram." 2015 IEEE World Haptics Conference (WHC). IEEE, 2015.
#[derive(Gain)]
pub struct SDP<B: LinAlgBackend + 'static> {
    foci: Vec<Vector3>,
    amps: Vec<Amplitude>,
    alpha: float,
    lambda: float,
    repeat: usize,
    constraint: EmissionConstraint,
    backend: Rc<B>,
}

impl_holo!(B, SDP<B>);

impl<B: LinAlgBackend + 'static> SDP<B> {
    pub fn new(backend: Rc<B>) -> Self {
        Self {
            foci: vec![],
            amps: vec![],
            alpha: 1e-3,
            lambda: 0.9,
            repeat: 100,
            backend,
            constraint: EmissionConstraint::Normalize,
        }
    }

    pub fn with_alpha(self, alpha: float) -> Self {
        Self { alpha, ..self }
    }

    pub fn with_lambda(self, lambda: float) -> Self {
        Self { lambda, ..self }
    }

    pub fn with_repeat(self, repeat: usize) -> Self {
        Self { repeat, ..self }
    }

    pub fn alpha(&self) -> float {
        self.alpha
    }

    pub fn lambda(&self) -> float {
        self.lambda
    }

    pub fn repeat(&self) -> usize {
        self.repeat
    }
}

impl<B: LinAlgBackend> Gain for SDP<B> {
    #[allow(non_snake_case)]
    fn calc(
        &self,
        geometry: &Geometry,
        filter: GainFilter,
    ) -> Result<HashMap<usize, Vec<Drive>>, AUTDInternalError> {
        let G = self
            .backend
            .generate_propagation_matrix(geometry, &self.foci, &filter)?;

        let m = self.backend.cols_c(&G)?;
        let n = self.foci.len();

        let zeros = self.backend.alloc_zeros_cv(n)?;
        let ones = self.backend.from_slice_cv(&vec![1.; n])?;

        let mut a = self.backend.alloc_zeros_cm(n, n)?;
        let amps = self.backend.from_slice_cv(self.amps_as_slice())?;
        self.backend.create_diagonal_c(&amps, &mut a)?;

        let mut pseudo_inv_G = self.backend.alloc_zeros_cm(m, n)?;
        let mut u_ = self.backend.alloc_cm(n, n)?;
        let mut s = self.backend.alloc_cm(m, n)?;
        let mut vt = self.backend.alloc_cm(m, m)?;
        let mut buf = self.backend.alloc_zeros_cm(m, n)?;
        let G_ = self.backend.clone_cm(&G)?;
        self.backend.pseudo_inverse_svd(
            G_,
            self.alpha,
            &mut u_,
            &mut s,
            &mut vt,
            &mut buf,
            &mut pseudo_inv_G,
        )?;

        let M = {
            let mut M = self.backend.alloc_cm(n, n)?;
            self.backend.create_diagonal_c(&ones, &mut M)?;

            self.backend.gemm_c(
                Trans::NoTrans,
                Trans::NoTrans,
                Complex::new(-1., 0.),
                &G,
                &pseudo_inv_G,
                Complex::new(1., 0.),
                &mut M,
            )?;

            let mut tmp = self.backend.alloc_zeros_cm(n, n)?;
            self.backend.gemm_c(
                Trans::NoTrans,
                Trans::NoTrans,
                Complex::new(1., 0.),
                &a,
                &M,
                Complex::new(0., 0.),
                &mut tmp,
            )?;
            self.backend.gemm_c(
                Trans::NoTrans,
                Trans::NoTrans,
                Complex::new(1., 0.),
                &tmp,
                &a,
                Complex::new(0., 0.),
                &mut M,
            )?;
            M
        };

        let mut U = self.backend.alloc_cm(n, n)?;
        self.backend.create_diagonal_c(&ones, &mut U)?;

        let mut rng = rand::thread_rng();

        let mut x = self.backend.alloc_zeros_cv(n)?;
        let mut Mc = self.backend.alloc_cv(n)?;
        for _ in 0..self.repeat {
            let i = rng.gen_range(0..n);

            self.backend.get_col_c(&M, i, &mut Mc)?;
            self.backend.set_cv(i, Complex::new(0., 0.), &mut Mc)?;

            self.backend.gemv_c(
                Trans::NoTrans,
                Complex::new(1., 0.),
                &U,
                &Mc,
                Complex::new(0., 0.),
                &mut x,
            )?;

            let gamma = self.backend.dot_c(&x, &Mc)?;
            if gamma.re > 0. {
                self.backend
                    .scale_assign_cv(Complex::new(-(self.lambda / gamma.re).sqrt(), 0.), &mut x)?;

                self.backend.set_col_c(&x, i, 0, i, &mut U)?;
                self.backend.set_col_c(&x, i, i + 1, n, &mut U)?;
                self.backend.conj_assign_v(&mut x)?;
                self.backend.set_row_c(&x, i, 0, i, &mut U)?;
                self.backend.set_row_c(&x, i, i + 1, n, &mut U)?;
            } else {
                self.backend.set_col_c(&zeros, i, 0, i, &mut U)?;
                self.backend.set_col_c(&zeros, i, i + 1, n, &mut U)?;
                self.backend.set_row_c(&zeros, i, 0, i, &mut U)?;
                self.backend.set_row_c(&zeros, i, i + 1, n, &mut U)?;
            }
        }

        let u = self.backend.max_eigen_vector_c(U)?;

        let mut ut = self.backend.alloc_zeros_cv(n)?;
        self.backend.gemv_c(
            Trans::NoTrans,
            Complex::new(1., 0.),
            &a,
            &u,
            Complex::new(0., 0.),
            &mut ut,
        )?;

        let mut q = self.backend.alloc_zeros_cv(m)?;
        self.backend.gemv_c(
            Trans::NoTrans,
            Complex::new(1., 0.),
            &pseudo_inv_G,
            &ut,
            Complex::new(0., 0.),
            &mut q,
        )?;
        self.backend
            .scale_assign_cv(Complex::new(1. / T4010A1_AMPLITUDE, 0.0), &mut q)?;

        generate_result(
            geometry,
            self.backend.to_host_cv(q)?,
            &self.constraint,
            filter,
        )
    }
}