bootstrap_ht/lib.rs
1// Copyright (c) 2022. Sebastien Soudan
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http:www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15//! Bootstrap Hypothesis Testing
16//!
17//! Check the [`prelude`] module for the public API.
18use thiserror::Error;
19
20/// The prelude module re-exports the most commonly used types and traits.
21/// This is the public API. Enjoy!
22pub mod prelude;
23
24#[cfg(any(feature = "unstable", test))]
25/// unstable bootstrap API
26pub mod bootstrap;
27
28#[cfg(not(any(feature = "unstable", test)))]
29pub(crate) mod bootstrap;
30
31#[cfg(any(feature = "unstable", test))]
32/// unstable utils API
33pub mod utils;
34
35#[cfg(not(any(feature = "unstable", test)))]
36pub(crate) mod utils;
37
38/// The error type for this crate.
39#[derive(Debug, Clone, Error)]
40pub enum Error {
41 /// NotEnoughSamples
42 #[error("Not enough samples")]
43 NotEnoughSamples,
44}