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


#if @HELP_YEARS2HOURS

    YEARS2HOURS

    Purpose: Converts years to hours.

    Syntax:  YEARS2HOURS(years)

              years - A scalar or series, the years values.


    Returns: A scalar or series of hour values.

    Example:
             years2hours(3)

             returns 26280, the number of hours in 3 years.

    Example:
             hours2years(years2hours(3))

             returns 3 years showing hours2years and years2hours are inverse
             functions.

    Example:
             W1: 0..0.2..1
             W2: years2hours(w1)
             W3: hours2years(w2)

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

             W2 contains the hour series {0, 1752, 3504, 5256, 7008, 8760}

             W3 recovers the original years series.

    Remarks:
             YEARS2HOURS converts a year value or series to hours.

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

             See HOURS2YEARS to convert an hour value or series to years.

    See Also:
             HOURS2YEARS
             YEARS2DAYS
             YEARS2MINUTES
             YEARS2SECONDS
#endif


/* convert years to hours */
years2hours(years = 0)
{
        local hours;

        hours = days2hours(years2days(years));

        return(hours);
}