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


#if @HELP_YEARS2SECONDS

    YEARS2SECONDS

    Purpose: Converts years to seconds.

    Syntax:  YEARS2SECONDS(years)

              years - A scalar or series, the years values.


    Returns: A scalar or series of seconds values.

    Example:
             years2seconds(3)

             returns 94608000, the number of seconds in 3 years.

    Example:
             seconds2years(years2seconds(3))

             returns 3 years showing seconds2years and years2seconds are
             inverse functions.

    Example:
             W1: 0..0.2..1
             W2: years2seconds(w1)
             W3: seconds2years(w2)

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

             W2 contains the seconds series:
             
             {0, 6307200, 12614400, 18921600, 25228800, 31536000}

             W3 recovers the original years series.

    Remarks:
             YEARS2SECONDS converts a year value or series to seconds.

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

             See SECONDS2YEARS to convert a seconds value or series to years.

    See Also:
             SECONDS2YEARS
             YEARS2DAYS
             YEARS2HOURS
             YEARS2MINUTES
#endif


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

        seconds = days2seconds(years2days(years));

        return(seconds);
}