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 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
use num::{Float, NumCast};
use array_matrix::*;
/// State-space equation matrices A, B, C and D contained in one structure
pub struct StateSpace<F: Float, const VARCOUNT: usize>
where
[[F; VARCOUNT]; VARCOUNT]: SquareMatrix,
[[F; 1]; VARCOUNT]: Matrix,
[[F; VARCOUNT]; 1]: Matrix
{
pub a: [[F; VARCOUNT]; VARCOUNT],
pub b: [[F; 1]; VARCOUNT],
pub c: [[F; VARCOUNT]; 1],
pub d: F
}
impl<F: Float, const VARCOUNT: usize> StateSpace<F, VARCOUNT>
where
[[F; VARCOUNT]; VARCOUNT]: SquareMatrix,
[[F; 1]; VARCOUNT]: Matrix,
[[F; VARCOUNT]; 1]: Matrix
{
/// Creates a new state-space struct in control-canonical form
///
/// # Arguments
///
/// * `a` - Transfer function denominator polynomial
/// * `b` - Transfer function enumerator polynomial
///
/// # Examples
///
/// ```rust
/// let a = [1.0, 2.0, 3.0];
/// let b = [4.0, 5.0, 6.0];
///
/// let ss = StateSpace::new_control_canonical_form(a, b);
///
/// assert_eq!(ss.a, [
/// [-a[0], -a[1], -a[2]],
/// [1.0, 0.0, 0.0],
/// [0.0, 1.0, 0.0]
/// ]);
/// assert_eq!(ss.b, [
/// [1.0],
/// [0.0],
/// [0.0]
/// ]);
/// assert_eq!(ss.c, [
/// [b[0], b[1], b[2]]
/// ]);
/// assert_eq!(ss.d, 0.0);
/// ```
pub fn new_control_canonical_form(a: [F; VARCOUNT], b: [F; VARCOUNT]) -> Self
{
Self {
a: array_init::array_init(|r| if r == 0 {
a.map(|ai| -ai)
} else {
array_init::array_init(|c| if r == c + 1 {F::one()} else {F::zero()})
}),
b: array_init::array_init(|r| if r == 0 {[F::one()]} else {[F::zero()]}),
c: [b],
d: F::zero()
}
}
/// Creates a new state-space struct in observer-canonical form
///
/// # Arguments
///
/// * `a` - Transfer function denominator polynomial
/// * `b` - Transfer function enumerator polynomial
///
/// # Examples
///
/// ```rust
/// let a = [1.0, 2.0, 3.0];
/// let b = [4.0, 5.0, 6.0];
///
/// let ss = StateSpace::new_observer_canonical_form(a, b);
///
/// assert_eq!(ss.a, [
/// [-a[0], 1.0, 0.0],
/// [-a[1], 0.0, 1.0],
/// [-a[2], 0.0, 0.0]
/// ]);
/// assert_eq!(ss.b, [
/// [b[0]],
/// [b[1]],
/// [b[2]]
/// ]);
/// assert_eq!(ss.c, [
/// [1.0, 0.0, 0.0]
/// ]);
/// assert_eq!(ss.d, 0.0);
/// ```
pub fn new_observer_canonical_form(a: [F; VARCOUNT], b: [F; VARCOUNT]) -> Self
{
Self {
a: array_init::array_init(|r| if r == 0 {
a.map(|ai| -ai)
} else {
array_init::array_init(|c| if r == c + 1 {F::one()} else {F::zero()})
}).transpose(),
b: [b].transpose(),
c: [array_init::array_init(|r| if r == 0 {F::one()} else {F::zero()})],
d: F::zero()
}
}
/// Returns the controllability-matrix of the state-space equation
///
/// 𝒞
///
/// # Examples
///
/// ```rust
/// let cc = ss.controllability()
/// ```
pub fn controllability(&self) -> [[F; VARCOUNT]; VARCOUNT]
{
array_init::array_init(|n| {
let mut b: [[F; 1]; VARCOUNT] = self.b;
for _ in 0..n
{
b = self.a.mul(b);
}
b.transpose()[0]
}).transpose()
}
/// Checks if the controllability-matrix is nonzero
///
/// det(𝒞) != 0
///
/// # Examples
///
/// ```rust
/// ss.is_controllable()
/// ```
pub fn is_controllable(&self) -> bool
where
[[F; VARCOUNT]; VARCOUNT]: Det<Output = F>
{
!self.controllability().det().is_zero()
}
/// Returns the observability-matrix of the state-space equation
///
/// 𝒪
///
/// # Examples
///
/// ```rust
/// let cc = ss.observability()
/// ```
pub fn observability(&self) -> [[F; VARCOUNT]; VARCOUNT]
{
array_init::array_init(|n| {
let mut c: [[F; VARCOUNT]; 1] = self.c;
for _ in 0..n
{
c = c.mul(self.a);
}
c[0]
})
}
/// Checks if the observability-matrix is nonzero
///
/// det(𝒪) != 0
///
/// # Examples
///
/// ```rust
/// ss.is_observable()
/// ```
pub fn is_observable(&self) -> bool
where
[[F; VARCOUNT]; VARCOUNT]: Det<Output = F>
{
!self.observability().det().is_zero()
}
/// Transforms the form of the state-space system by a transformation matrix
///
/// A' = T⁻¹AT
///
/// B' = T⁻¹B
///
/// C' = CT
///
/// D' = D
///
/// # Arguments
///
/// * `t` - The transformation matrix
///
/// # Examples
///
/// ```rust
/// let sst = ss.transform_state(t)
/// ```
pub fn transform_state(&self, t: [[F; VARCOUNT]; VARCOUNT]) -> Option<Self>
where [[F; VARCOUNT]; VARCOUNT]: MInv<Output = [[F; VARCOUNT]; VARCOUNT]>
{
t.inv().map(|t_| Self {
a: t_.mul(self.a).mul(t),
b: t_.mul(self.b),
c: self.c.mul(t),
d: self.d
})
}
/// Transforms any state-space system into control-canonical form
///
/// # Examples
///
/// ```rust
/// let ssc = ss.transform_into_control_canonical_form()
/// ```
pub fn transform_into_control_canonical_form(&self) -> Option<Self>
where [[F; VARCOUNT]; VARCOUNT]: MInv<Output = [[F; VARCOUNT]; VARCOUNT]>
{
self.controllability().inv().map(|cc_| {
let tn = [array_init::array_init(|c| if c == 0 {F::one()} else {F::zero()})].mul(cc_);
let mut tna = tn;
let mut t = array_init::array_init(|_| {
let tn = tna;
tna = tna.mul(self.a);
tn[0]
});
t.reverse();
return self.transform_state(t)
}).flatten()
}
/// Transforms any state-space system into observer-canonical form
///
/// # Examples
///
/// ```rust
/// let sso = ss.transform_into_observer_canonical_form()
/// ```
pub fn transform_into_observer_canonical_form(&self) -> Option<Self>
where [[F; VARCOUNT]; VARCOUNT]: MInv<Output = [[F; VARCOUNT]; VARCOUNT]>
{
self.transform_into_control_canonical_form().map(|ccf| Self {
a: ccf.a.transpose(),
b: ccf.c.transpose(),
c: ccf.b.transpose(),
d: ccf.d
})
}
/// Returns the derivative of the internal variables according to the state-space equations
///
/// # Arguments
///
/// * `x` - The state of the internal state-space variables organized in a collumn-vector
/// * `u` - The system input state
///
/// # Examples
///
/// ```rust
/// let dt = 0.0001;
/// let mut x = [
/// [0.0],
/// [0.0]
/// ];
/// let mut u = 0.0;
/// for _ in 0..10000
/// {
/// x = x.add(ss.dxdt(x, u).mul(dt))
/// u = 1.0;
/// }
/// let y_ss = ss.y(x, u);
/// // Steady state error:
/// let e_ss = y_ss - u;
/// ```
pub fn dxdt(&self, x: [[F; 1]; VARCOUNT], u: F) -> [[F; 1]; VARCOUNT]
{
self.a.mul(x).add(self.b.mul(u))
}
/// Returns the output state according to the state-space equations
///
/// # Arguments
///
/// * `x` - The state of the internal state-space variables organized in a collumn-vector
/// * `u` - The system input state
///
/// # Examples
///
/// ```rust
/// let dt = 0.0001;
/// let mut x = [[0.0]; 2];
/// let mut u = 0.0;
/// for _ in 0..10000
/// {
/// x = x.add(ss.dxdt(x, u).mul(dt));
/// u = 1.0;
/// }
/// let y_ss = ss.y(x, u);
/// // Steady state error:
/// let e_ss = y_ss - u;
/// ```
pub fn y(&self, x: [[F; 1]; VARCOUNT], u: F) -> F
{
self.c.mul(x)[0][0] + self.d*u
}
}