/*****************************************************************************
*                                                                            *
*   YEARS2MINUTES.SPL Copyright (C) 2024 DSP Development Corporation         *
*                               All Rights Reserved                          *
*                                                                            *
*   Author:        Randy Race                                                *
*                                                                            *
*   Synopsis:      Converts years to minutes                                 *
*                                                                            *
*   Revisions:      2 Dec 2024  RRR  Creation                                *
*                                                                            *
*****************************************************************************/


#if @HELP_YEARS2MINUTES

    YEARS2MINUTES

    Purpose: Converts years to minutes.

    Syntax:  YEARS2MINUTES(years)

              years - A scalar or series, the years values.


    Returns: A scalar or series of minutes values.

    Example:
             years2minutes(3)

             returns 15768000, the number of minutes in 3 years.

    Example:
             minutes2years(years2minutes(3))

             returns 3 years showing minutes2years and years2minutes are
             inverse functions.

    Example:
             W1: 0..0.2..1
             W2: years2minutes(w1)
             W3: minutes2years(w2)

             W1 contains the years series: {0, 0.2, 0.4, 0.6, 0.8, 1.0}.

             W2 contains the minutes series: 
             
             {0, 105120, 210240, 315360, 420480, 525600}
             
             W3 recovers the original years series.

    Remarks:
             YEARS2MINUTES converts a year value or series to minutes.

             YEARS2MINUTES assumes that a leap year can occur four years
             after the first full year.

             See MINUTES2YEARS to convert a minutes value or series to years.

    See Also:
             MINUTES2YEARS
             YEARS2DAYS
             YEARS2HOURS
             YEARS2MINUTES
#endif


/* convert years to minutes */
years2minutes(years = 0)
{
        local seconds;

        seconds = days2minutes(years2days(years));

        return(seconds);
}