make sleef a default feature

bempp · mscroggs · Sep 18, 2024 · Sep 18, 2024 · Sep 18, 2024 · Sep 18, 2024
commit 8186b07abbfd8c83a16502bb7b4c465f4c943da6
diff --git a/Cargo.toml b/Cargo.toml
@@ -2,6 +2,8 @@
 nightly = ["pulp/nightly"]
 # Treat warnings as a build error.
 strict = []
+sleef = ["rlst/sleef"]
+default = ["sleef"]
 
 [package]
 name = "green-kernels"
@@ -27,7 +29,7 @@ approx = { version = "0.5", features = ["num-complex"] }
 rayon = "1.9"
 num = "0.4"
 num_cpus = "1"
-rlst = { version = "0.2", features = ["sleef"] }
+rlst = { version = "0.2" }
 rand = "0.8.5"
 itertools = { version = "0.13.0", default-features = false }
 coe-rs = "0.1.2"

diff --git a/src/traits.rs b/src/traits.rs

    /// Single threaded evaluation of Green's functions.
    ///
    /// - `eval_type`: Either [EvalType::Value] to only return Green's function values
    ///              or [EvalType::ValueDeriv] to return values and derivatives.
    /// - `sources`: A slice defining the source points. The points must be given in the form
    ///            `[x_1, x_2, ... x_N, y_1, y_2, ..., y_N, z_1, z_2, ..., z_N]`, that is
    ///            the value for each dimension must be continuously contained in the slice.
    /// - `targets`: A slice defining the targets. The memory layout is the same as for sources.
    /// - `charges`: A slice defining the charges. For each source point there needs to be one charge.
    /// - `result`: The result array. If the kernel is RlstScalar and `eval_type` has the value [EvalType::Value]
    ///           then `result` has the same number of elemens as there are targets. For a RlstScalar kernel
    ///           in three dimensional space if [EvalType::ValueDeriv] was chosen then `result` contains
    ///           for each target in consecutive order the value of the kernel and the three components
    ///           of its derivative.
    ///

    /// Single threaded assembly of a kernel matrix.
    ///
    /// - `eval_type`: Either [EvalType::Value] to only return Green's function values
    ///              or [EvalType::ValueDeriv] to return values and derivatives.
    /// - `sources`: A slice defining the source points. The points must be given in the form
    ///            `[x_1, x_2, ... x_N, y_1, y_2, ..., y_N, z_1, z_2, ..., z_N]`, that is
    ///            the value for each dimension must be continuously contained in the slice.
    /// - `targets`: A slice defining the targets. The memory layout is the same as for sources.
    /// - `result`: The result array. If the kernel is RlstScalar and `eval_type` has the value [EvalType::Value]
    ///           then `result` is equivalent to a column major matrix of dimension [S, T], where S is the number of sources and
    ///           T is the number of targets. Hence, for each target all corresponding source evaluations are consecutively in memory.
    ///           For a RlstScalar kernel in three dimensional space if [EvalType::ValueDeriv] was chosen then `result` is equivalent
    ///           to a column-major matrix of dimension [4 * S, T], where the first 4 rows are the values of Green's fct. value and
    ///           derivatives for the first source and all targets. The next 4 rows correspond to values and derivatives of second source
    ///           with all targets and so on.

    /// Return the range component count of the Green's fct.
    ///
    /// For a RlstScalar kernel this is `1` if [EvalType::Value] is
    /// given, and `4` if [EvalType::ValueDeriv] is given.
    fn range_component_count(&self, eval_type: GreenKernelEvalType) -> usize;
 }

	/// Single threaded evaluation of Green's functions.
	///
	/// - `eval_type`: Either [EvalType::Value] to only return Green's function values
Check warning on line 21 in src/traits.rs GitHub Actions / Build docs unresolved link to `EvalType::Value` Check warning on line 21 in src/traits.rs GitHub Actions / Build docs unresolved link to `EvalType::Value`
	/// or [EvalType::ValueDeriv] to return values and derivatives.
Check warning on line 22 in src/traits.rs GitHub Actions / Build docs unresolved link to `EvalType::ValueDeriv` Check warning on line 22 in src/traits.rs GitHub Actions / Build docs unresolved link to `EvalType::ValueDeriv`
	/// - `sources`: A slice defining the source points. The points must be given in the form
	/// `[x_1, x_2, ... x_N, y_1, y_2, ..., y_N, z_1, z_2, ..., z_N]`, that is
	/// the value for each dimension must be continuously contained in the slice.
	/// - `targets`: A slice defining the targets. The memory layout is the same as for sources.
	/// - `charges`: A slice defining the charges. For each source point there needs to be one charge.
	/// - `result`: The result array. If the kernel is RlstScalar and `eval_type` has the value [EvalType::Value]
Check warning on line 28 in src/traits.rs GitHub Actions / Build docs unresolved link to `EvalType::Value` Check warning on line 28 in src/traits.rs GitHub Actions / Build docs unresolved link to `EvalType::Value`
	/// then `result` has the same number of elemens as there are targets. For a RlstScalar kernel
	/// in three dimensional space if [EvalType::ValueDeriv] was chosen then `result` contains
Check warning on line 30 in src/traits.rs GitHub Actions / Build docs unresolved link to `EvalType::ValueDeriv` Check warning on line 30 in src/traits.rs GitHub Actions / Build docs unresolved link to `EvalType::ValueDeriv`
	/// for each target in consecutive order the value of the kernel and the three components
	/// of its derivative.
	///

	/// Single threaded assembly of a kernel matrix.
	///
	/// - `eval_type`: Either [EvalType::Value] to only return Green's function values
Check warning on line 58 in src/traits.rs GitHub Actions / Build docs unresolved link to `EvalType::Value` Check warning on line 58 in src/traits.rs GitHub Actions / Build docs unresolved link to `EvalType::Value`
	/// or [EvalType::ValueDeriv] to return values and derivatives.
Check warning on line 59 in src/traits.rs GitHub Actions / Build docs unresolved link to `EvalType::ValueDeriv` Check warning on line 59 in src/traits.rs GitHub Actions / Build docs unresolved link to `EvalType::ValueDeriv`
	/// - `sources`: A slice defining the source points. The points must be given in the form
	/// `[x_1, x_2, ... x_N, y_1, y_2, ..., y_N, z_1, z_2, ..., z_N]`, that is
	/// the value for each dimension must be continuously contained in the slice.
	/// - `targets`: A slice defining the targets. The memory layout is the same as for sources.
	/// - `result`: The result array. If the kernel is RlstScalar and `eval_type` has the value [EvalType::Value]
Check warning on line 64 in src/traits.rs GitHub Actions / Build docs unresolved link to `EvalType::Value` Check warning on line 64 in src/traits.rs GitHub Actions / Build docs unresolved link to `EvalType::Value`
	/// then `result` is equivalent to a column major matrix of dimension [S, T], where S is the number of sources and
	/// T is the number of targets. Hence, for each target all corresponding source evaluations are consecutively in memory.
	/// For a RlstScalar kernel in three dimensional space if [EvalType::ValueDeriv] was chosen then `result` is equivalent
Check warning on line 67 in src/traits.rs GitHub Actions / Build docs unresolved link to `EvalType::ValueDeriv` Check warning on line 67 in src/traits.rs GitHub Actions / Build docs unresolved link to `EvalType::ValueDeriv`
	/// to a column-major matrix of dimension [4 * S, T], where the first 4 rows are the values of Green's fct. value and
	/// derivatives for the first source and all targets. The next 4 rows correspond to values and derivatives of second source
	/// with all targets and so on.

	/// Return the range component count of the Green's fct.
	///
	/// For a RlstScalar kernel this is `1` if [EvalType::Value] is
Check warning on line 108 in src/traits.rs GitHub Actions / Build docs unresolved link to `EvalType::Value` Check warning on line 108 in src/traits.rs GitHub Actions / Build docs unresolved link to `EvalType::Value`
	/// given, and `4` if [EvalType::ValueDeriv] is given.
Check warning on line 109 in src/traits.rs GitHub Actions / Build docs unresolved link to `EvalType::ValueDeriv` Check warning on line 109 in src/traits.rs GitHub Actions / Build docs unresolved link to `EvalType::ValueDeriv`
	fn range_component_count(&self, eval_type: GreenKernelEvalType) -> usize;
	}