Skip to content

Commit 8d93e6f

Browse files
committed
Add docs for ConsGenerator trait
1 parent 3625eaf commit 8d93e6f

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

src/data/mod.rs

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,29 @@ extern {
5454
fn af_replace_scalar(a: AfArray, cond: AfArray, b: c_double) -> c_int;
5555
}
5656

57+
/// Type Trait to generate a constant [Array](./struct.Array.html) of given size
58+
///
59+
/// Internally, ConstGenerator trait is implemented by following types.
60+
///
61+
/// - f32
62+
/// - f64
63+
/// - num::Complex\<f32\>
64+
/// - num::Complex\<f64\>
65+
/// - bool
66+
/// - i32
67+
/// - u32
68+
/// - u8
69+
/// - i64
70+
/// - u64
71+
/// - i16
72+
/// - u16
73+
///
5774
pub trait ConstGenerator {
75+
/// Create an Array of `dims` size from scalar value `self`.
76+
///
77+
/// # Parameters
78+
///
79+
/// - `dims` are the dimensions of the output constant [Array](./struct.Array.html)
5880
fn generate(&self, dims: Dim4) -> Array;
5981
}
6082

0 commit comments

Comments
 (0)