Home > brede > brede_mat_scale.m

brede_mat_scale

PURPOSE ^

brede_mat_scale - Scale a matrix

SYNOPSIS ^

function Mout = brede_mat_scale(Min, varargin)

DESCRIPTION ^

 brede_mat_scale      - Scale a matrix

       function Mout = brede_mat_scale(Min)

       Input:    Min   'Mat' structure
 
       Property: Type  [ ColumnSum | ColumnSSR | ColumnZScore |
                       {Correspondence} | idf | RowMean | RowSum |
                       RowSSR | RowZScore | sqrt ] Type of
                       normalization/scaling  

       Output:   Mout  'Mat' structure

       This function will scale a matrix.

       'Correspondence' will scale both the rows and the columns
       according to the square root of the column row and column
       sum. 

       'Idf' is inverse document frequency scaling with 'term' in the
       columns and 'documents' in the rows.

       'RowSSR' is 'row square sum (square) root' where the elements
       are squared and then summed along each row. Finally the
       square root is taken of the sum. The value is used as the
       normalization factor that is divided on each element in the
       row. 

       NaN elements are ignored for 'ColumnSSR', 'RowMean', 'RowSSR'
       and 'RowSum'. 
         
       'Sqrt' is elementwise square root.

       See also BREDE, BREDE_MAT, BREDE_MAT_ADD, BREDE_MAT_PRODUCT.

 $Id: brede_mat_scale.m,v 1.13 2008/05/15 16:12:42 fn Exp $

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Fri 27-Nov-2009 18:11:22 by m2html © 2005