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


#if @HELP_HOURS2MINUTES

    HOURS2MINUTES

    Purpose: Converts hours to minutes.

    Syntax:  HOURS2MINUTES(hours)

              hours - A scalar or series, the hours values.


    Returns: A scalar or series of minutes values.

    Example:
             hours2minutes(3)

             returns 180, the number of minutes in 3 hours.

    Example:
             minutes2hours(hours2minutes(3))

             returns 3 hours showing minutes2hours and hours2minutes are
             inverse functions.

    Example:
             W1: 0..0.2..1
             W2: hours2minutes(w1)
             W3: minutes2hours(w2)

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

             W2 contains the minutes series {0, 12, 24, 26, 48, 60}.

             W3 recovers the original hours series.

    Remarks:
             HOURS2MINUTES converts an hour value or series to minutes.

             See MINUTES2HOURS to convert a minutes value or series to
             hours.

    See Also:
             HOURS2DAYS
             HOURS2SECONDS
             HOURS2YEARS
             MINUTES2HOURS
#endif


/* convert hours to minutes */
hours2minutes(hours = 0)
{
        local minutes;

        minutes = hours * 60;

        if (isarray(minutes))
        {
                setvunits(minutes, "Minutes", -1);
        }

        return(minutes);
}