Home > freetb4matlab > NaN > geomean.m

geomean

PURPOSE ^

GEOMEAN calculates the geomentric mean of data elements.

SYNOPSIS ^

function [y] = geomean(x,DIM,W)

DESCRIPTION ^

 GEOMEAN calculates the geomentric mean of data elements. 
 
     y = geomean(x [,DIM [,W]])   is the same as 
     y = mean(x,'G' [,DIM]) 

 DIM    dimension
    1 STD of columns
    2 STD of rows
    default or []: first DIMENSION, with more than 1 element
 W    weights to compute weighted mean (default: [])
    if W=[], all weights are 1. 
    number of elements in W must match size(x,DIM) 

 features:
 - can deal with NaN's (missing values)
 - weighting of data 
 - dimension argument also in Octave
 - compatible to Matlab and Octave

 see also: SUMSKIPNAN, MEAN, HARMMEAN

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; If not, see <http://www.gnu.org/licenses/>.

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Fri 22-May-2009 15:13:00 by m2html © 2003