Main Content

mean

Arithmetic average

collapse all in page

mean is not recommended. Use timetable instead. For more information, see Convert Financial Time Series Objects fints to Timetables.

Syntax

tsmean = mean(tsobj)

Description

example

tsmean = mean(tsobj) computes the arithmetic mean of all data in all series in the financial time series object (tsobj) and returns it in a structure tsmean. The tsmean structure contains field name(s) identical to the data series name(s).

Examples

collapse all

  1. Create a fints object.

    dates_and_times = (now:now+5)'
    dates_and_times =

   1.0e+05 *

    7.3840
    7.3840
    7.3840
    7.3841
    7.3841
    7.3841

     tsobj = fints(dates_and_times, randn(6,1))
    Warning: FINTS is not recommended. Use TIMETABLE instead. For more information, see Convert Financial Time Series Objects (fints) to Timetables. 
> In fints (line 169) 
    tsobj = 
 
    desc:  (none)
    freq:  Unknown (0)

    {'dates:  (6)'}    {'times:  (6)'}    {'series1:  (6)'}
    {'07-Sep-2021'}    {'12:30'      }    {[       0.5377]}
    {'08-Sep-2021'}    {'12:30'      }    {[       1.8339]}
    {'09-Sep-2021'}    {'12:30'      }    {[      -2.2588]}
    {'10-Sep-2021'}    {'12:30'      }    {[       0.8622]}
    {'11-Sep-2021'}    {'12:30'      }    {[       0.3188]}
    {'12-Sep-2021'}    {'12:30'      }    {[      -1.3077]}

  2. Calculate the natural logarithm using log.

    tsmean = mean(tsobj)
    Warning: FINTS is not recommended. Use TIMETABLE instead. For more information, see Convert Financial Time Series Objects (fints) to Timetables. 
> In fints/mean (line 22) 

tsmean = 

  struct with fields:

    series1: 0.5648

Input Arguments

collapse all

Financial time series object, specified as a fints object.

Data Types: object

Output Arguments

collapse all

Arithmetic mean of all data in all series in the financial time series object, returned as a structure.

Version History

Introduced before R2006a

See Also

|

Topics