/* TA-LIB Copyright (c) 1999-2025, Mario Fortier
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the following
 * conditions are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in
 *   the documentation and/or other materials provided with the
 *   distribution.
 *
 * - Neither name of author nor the names of its contributors
 *   may be used to endorse or promote products derived from this
 *   software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/* Important:
 *  This file is automatically generated by the utility ta_codegen.
 *  Any modifications will be lost on next execution of ta_codegen.
 *
 *  Modifications should instead be done with the "C" source file
 *  in ta-lib\src\ta_func
 */

/* List of contributors:
 *
 *  Initial  Name/description
 *  -------------------------------------------------------------------
 *  MF       Mario Fortier
 *  JD       jdoyle
 *
 * Change history:
 *
 *  MMDDYY BY     Description
 *  -------------------------------------------------------------------
 *  120802 MF     Template creation.
 *  052603 MF     Adapt code to compile with .NET Managed C++
 *  111705 MF,JD  Fix#1359452 for handling properly start/end range.
 */

// Import types from parent module
use super::*;

// Allow non-snake-case names to maintain TA-Lib API compatibility
#[allow(non_snake_case)]
#[allow(unused_variables)]
#[allow(dead_code)]
#[allow(unused_mut)]
#[allow(unused_assignments)]
impl Core {
    /// Lookback period for [`Core::ad`]: the number of leading input values consumed before the
    /// first output value can be produced.
    pub fn ad_lookback(&self) -> usize {
        // This function have no lookback needed.
        return (0) as usize;
    }
    /// Chaikin Accumulation/Distribution Line, a cumulative volume-flow indicator. Sums a
    /// volume-weighted money-flow multiplier per bar to gauge buying vs. selling pressure. Rising
    /// line = accumulation (buying pressure); falling = distribution.
    ///
    /// # Formula
    ///
    /// ```text
    /// MFM = ((close-low) - (high-close)) / (high-low); AD_t = AD_{t-1} + MFM_t * volume_t (running sum, seeded at 0)
    /// ```
    ///
    /// # Arguments
    ///
    /// * `startIdx` — Start index of the requested calculation range.
    /// * `endIdx` — End index of the requested calculation range (inclusive).
    /// * `inHigh` — High prices per bar.
    /// * `inLow` — Low prices per bar.
    /// * `inClose` — Close prices per bar.
    /// * `inVolume` — Volume per bar.
    /// * `outBegIdx` — Set to the input index of the first output value.
    /// * `outNBElement` — Set to the number of output values written.
    /// * `outReal` — Cumulative A/D line value per bar.
    ///
    /// # Errors
    ///
    /// Returns [`RetCode::OutOfRangeStartIndex`] when `endIdx < startIdx`.
    ///
    /// # Panics
    ///
    /// Input slices must cover `startIdx..=endIdx` and output slices must hold the number of values
    /// produced for that range: undersized slices panic or, for functions that forward to unchecked
    /// internals, cause undefined behavior. Sizing every output slice to the input length is always
    /// sufficient.
    ///
    /// # Examples
    ///
    /// ```
    /// use ta_lib::{Core, RetCode};
    ///
    /// let high: Vec<f64> = (0..252).map(|i| 101.0 + 10.0 * (0.1 * i as f64).sin()).collect();
    /// let low: Vec<f64> = (0..252).map(|i| 99.0 + 10.0 * (0.1 * i as f64).sin()).collect();
    /// let close: Vec<f64> = (0..252).map(|i| 100.0 + 10.0 * (0.1 * i as f64).sin()).collect();
    /// let volume: Vec<f64> = (0..252).map(|i| 10_000.0 + 100.0 * i as f64).collect();
    ///
    /// let core = Core::new();
    /// let mut out_beg = 0;
    /// let mut out_nb = 0;
    /// let mut out = vec![0.0; 252];
    ///
    /// let ret = core.ad(
    ///     0, high.len() - 1, &high, &low, &close, &volume,
    ///     &mut out_beg, &mut out_nb, &mut out,
    /// );
    /// assert_eq!(ret, RetCode::Success);
    /// assert!(out_nb > 0);
    /// ```
    ///
    /// # See also
    ///
    /// [`Core::adosc`] · [`Core::obv`]
    ///
    /// Further reading: [ta-lib.org/functions/ad](https://ta-lib.org/functions/ad/)
    #[doc(alias = "ChaikinADLine")]
    #[doc(alias = "AccumulationDistributionLine")]
    #[doc(alias = "AccumulationDistribution")]
    pub fn ad(
        &self,
        startIdx: usize,
        endIdx: usize,
        inHigh: &[f64],
        inLow: &[f64],
        inClose: &[f64],
        inVolume: &[f64],
        outBegIdx: &mut usize,
        outNBElement: &mut usize,
        outReal: &mut [f64],
    ) -> RetCode {
        if endIdx < startIdx {
            return RetCode::OutOfRangeStartIndex;
        }
        let mut startIdx = startIdx;
        let mut nbBar: usize = 0_usize;
        let mut currentBar: usize = 0_usize;
        let mut outIdx: usize = 0_usize;
        let mut high: f64 = 0.0_f64;
        let mut low: f64 = 0.0_f64;
        let mut close: f64 = 0.0_f64;
        let mut tmp: f64 = 0.0_f64;
        let mut ad: f64 = 0.0_f64;
        // Note: Results from this function might vary slightly
        //       from Metastock outputs. The reason being that
        //       Metastock use float instead of double and this
        //       cause a different floating-point precision to
        //       be used.
        //
        //       For most function, this is not an apparent difference
        //       but for function using large cummulative values (like
        //       this AD function), minor imprecision adds up and becomes
        //       significative.
        //
        //       For better precision, TA-Lib use double in all its
        //       its calculations.
        // Default return values
        nbBar = endIdx - startIdx + 1;
        (*outNBElement) = nbBar;
        (*outBegIdx) = startIdx;
        currentBar = startIdx;
        outIdx = 0;
        ad = 0.0;
        while nbBar != 0 {
            high = inHigh[currentBar];
            low = inLow[currentBar];
            tmp = high - low;
            close = inClose[currentBar];
            if tmp > 0.0 {
                ad += (close - low - (high - close)) / tmp * (inVolume[currentBar] as f64);
            }
            outReal[outIdx] = ad;
            outIdx += 1;
            currentBar += 1;
            nbBar -= 1;
        }
        return RetCode::Success;
    }
    /// Unchecked variant of [`Core::ad`], used for internal cross-indicator calls.
    ///
    /// Skips parameter validation and uses unchecked indexing internally. Every argument must
    /// satisfy the constraints documented on [`Core::ad`]; an out-of-range parameter, an input
    /// slice not covering `startIdx..=endIdx`, or an undersized output slice may panic or cause
    /// undefined behavior. Prefer [`Core::ad`].
    #[inline]
    pub fn ad_unguarded(
        &self,
        mut startIdx: usize,
        endIdx: usize,
        inHigh: &[f64],
        inLow: &[f64],
        inClose: &[f64],
        inVolume: &[f64],
        outBegIdx: &mut usize,
        outNBElement: &mut usize,
        outReal: &mut [f64],
    ) -> RetCode {
        let mut nbBar: usize = 0_usize;
        let mut currentBar: usize = 0_usize;
        let mut outIdx: usize = 0_usize;
        let mut high: f64 = 0.0_f64;
        let mut low: f64 = 0.0_f64;
        let mut close: f64 = 0.0_f64;
        let mut tmp: f64 = 0.0_f64;
        let mut ad: f64 = 0.0_f64;
        unsafe {
        assert!(endIdx < inHigh.len());
        assert!(endIdx < inLow.len());
        assert!(endIdx < inClose.len());
        assert!(endIdx < inVolume.len());
        let _assertLb = self.ad_lookback();
        let _assertStart = if startIdx > _assertLb { startIdx } else { _assertLb };
        assert!(_assertStart > endIdx || endIdx - _assertStart < outReal.len());
        nbBar = endIdx - startIdx + 1;
        (*outNBElement) = nbBar;
        (*outBegIdx) = startIdx;
        currentBar = startIdx;
        outIdx = 0;
        ad = 0.0;
        while nbBar != 0 {
            high = *inHigh.as_ptr().add(currentBar);
            low = *inLow.as_ptr().add(currentBar);
            tmp = high - low;
            close = *inClose.as_ptr().add(currentBar);
            if tmp > 0.0 {
                ad += (close - low - (high - close)) / tmp * (*inVolume.as_ptr().add(currentBar) as f64);
            }
            *outReal.as_mut_ptr().add(outIdx) = ad;
            outIdx += 1;
            currentBar += 1;
            nbBar -= 1;
        }
        return RetCode::Success;
        } // unsafe
    }
}
/***************/
/* End of File */
/***************/
