srenblad/nalgebra
1
0
Fork 0
forked from M-Labs/nalgebra
Code Pull Requests Activity

Add a note about the PhantomData in Matrix.

Browse Source
This commit is contained in:
Crozet Sébastien 2021-04-12 11:27:21 +02:00
parent 2bef19ed5c
commit ee1c0be2dd
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/base/matrix.rs
View File

@ -176,6 +176,16 @@ pub struct Matrix<T, R, C, S> {
/// starts at 0 as you would expect. /// starts at 0 as you would expect.
pub data: S, pub data: S,
// NOTE: the fact that this field is private is important because
// this prevents the user from constructing a matrix with
// dimensions R, C that don't match the dimension of the
// storage S. Instead they have to use the unsafe function
// from_data_statically_unchecked.
// Note that it would probably make sense to just have
// the type `Matrix<S>`, and have `T, R, C` be associated-types
// of the `Storage` trait. However, because we don't have
// specialization, this is not bossible because these `T, R, C`
// allows us to desambiguate a lot of configurations.
_phantoms: PhantomData<(T, R, C)>, _phantoms: PhantomData<(T, R, C)>,
} }