Skip to main content

ferric_alpha/
lib.rs

1#![forbid(unsafe_code)]
2
3mod calendar;
4mod clean;
5mod data;
6mod error;
7mod forward_returns;
8mod performance;
9mod quantiles;
10mod report;
11mod statistics;
12
13pub const VERSION: &str = env!("CARGO_PKG_VERSION");
14pub use calendar::{Period, TradingCalendar};
15pub use clean::{
16    CleanFactorResult, CleanOptions, LossReport, get_clean_factor,
17    get_clean_factor_and_forward_returns, get_clean_factor_and_forward_returns_with_options,
18};
19pub use data::validate_factor_frame;
20pub use error::{FerricAlphaError, Result};
21pub use forward_returns::{
22    ForwardReturnsOptions, compute_forward_returns, compute_forward_returns_with_options,
23};
24pub use performance::{
25    AlphaBetaOptions, CommonStartReturnsOptions, EventReturnsOptions, IcOptions, MeanIcOptions,
26    MeanReturnByQuantileOptions, PortfolioOptions, PyfolioInput, ReturnOptions, TimeBucket,
27    WeightOptions, average_cumulative_return_by_quantile,
28    average_cumulative_return_by_quantile_from_prices, common_start_returns,
29    compute_mean_returns_spread, create_pyfolio_input, cumulative_returns, factor_alpha_beta,
30    factor_cumulative_returns, factor_information_coefficient, factor_positions,
31    factor_rank_autocorrelation, factor_returns, factor_weights, mean_information_coefficient,
32    mean_return_by_quantile, positions, quantile_turnover,
33};
34pub use quantiles::{QuantizeOptions, quantize_factor};
35pub use report::{
36    ColumnRole, DisplayFormat, DisplayUnit, EventReturnsReportData, EventReturnsTearSheetData,
37    EventStudyReportData, EventStudyTearSheetData, EventStudyTearSheetOptions, FullReportData,
38    FullTearSheetData, FullTearSheetOptions, InformationReportData, InformationTearSheetData,
39    InformationTearSheetOptions, ReportColumn, ReportColumnData, ReportKind, ReportMetadata,
40    ReportTable, ReportTimeUnit, ReturnsReportData, ReturnsTearSheetData, ReturnsTearSheetOptions,
41    SummaryReportData, SummaryTearSheetData, SummaryTearSheetOptions, TearSheetData,
42    TurnoverReportData, TurnoverTearSheetData, TurnoverTearSheetOptions,
43    create_event_returns_tear_sheet_data, create_event_study_tear_sheet_data,
44    create_full_tear_sheet_data, create_information_tear_sheet_data,
45    create_returns_tear_sheet_data, create_summary_tear_sheet_data,
46    create_turnover_tear_sheet_data, factor_quantile_statistics,
47};
48pub use statistics::{
49    LinearFit, QqPoint, TTest, average_rank, biased_excess_kurtosis, biased_skew, normal_qq,
50    one_sample_t_test, pearson, sample_std, simple_ols, spearman, std_error,
51};
52
53#[cfg(test)]
54mod tests {
55    #[test]
56    fn crate_version_matches_package_version() {
57        assert_eq!(super::VERSION, env!("CARGO_PKG_VERSION"));
58    }
59}