Skip to content
This repository was archived by the owner on Dec 2, 2025. It is now read-only.

Commit 1622fce

Browse files
authored
Document fix (#105)
1 parent 6336c0c commit 1622fce

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

src/traits.rs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,14 @@ pub trait FiniteElement {
5656
fn dim(&self) -> usize;
5757

5858
/// The shape of the values returned by functions in $\mathcal{V}$.
59+
///
60+
/// If the values are scalar an empty slice is returned.
5961
fn value_shape(&self) -> &[usize];
6062

6163
/// The number of values returned.
6264
///
63-
/// If e.g. `value_shape = [3, 4]` then `value_size = 3 x 4 = 12`.
65+
/// This is the product of the elements of `value_shape`, e.g. if `value_shape = [3, 4]` then `value_size = 3 x 4 = 12`.
66+
/// If `value_shape` returns an empty array (i.e. the shape functions are scalar) the convention is used that the product of the elements of an empty array is `1`.
6467
fn value_size(&self) -> usize;
6568

6669
/// Tabulate the values of the basis functions and their derivatives at a set of points

0 commit comments

Comments
 (0)