//! Errors related to the fft module.

use failure::Error;

/// Defines all of the possible FFTError types that we could have when
/// we are working with the `fft` module.
#[derive(Fail, Debug)]
pub enum FFTErrors {
    /// This error occurs when an error triggers on any of the fft module
    /// functions.
    #[fail(
        display = "Log-size of the EvaluationDomain group > TWO_ADACITY\
    Size: {:?} > TWO_ADACITY = {:?}",
        log_size_of_group, adacity
    )]
    InvalidEvalDomainSize {
        /// Log size of the group
        log_size_of_group: u32,
        /// Two adacity generated
        adacity: u32,
    },
}

#[derive(Debug, Fail)]
#[fail(display = "FFT module error")]
/// Represents an error triggered on any of the FFT module operations
/// such as `Polynomial` or `EvaluationDomain`
pub struct FFTError(#[fail(cause)] pub(crate) Error);