Home > freetb4matlab > signal > buffer.m

buffer

PURPOSE ^

% Buffer a signal into a data frame. The arguments to @code{buffer} are

SYNOPSIS ^

function [y, z, opt] = buffer (x, n, p, opt)

DESCRIPTION ^

% -*- texinfo -*-
% @deftypefn {Function File} {@var{y} = } buffer (@var{x}, @var{n}, @var{p}, @var{opt})
% @deftypefnx {Function File} {[@var{y}, @var{z}, @var{opt}] = } buffer (@dots{})
% Buffer a signal into a data frame. The arguments to @code{buffer} are
%
% @table @asis
% @item @var{x}
% The data to be buffered. 
%
% @item @var{n}
% The number of rows in the produced data buffer. This is an positive
% integer value and must be supplied.
%
% @item @var{p}
% An integer less than @var{n} that specifies the under- or overlap
% between column in the data frame. The default value of @var{p} is 0.
%
% @item @var{opt}
% In the case of an overlap, @var{opt} can be either a vector of length
% @var{p} or the string 'nodelay'. If @var{opt} is a vector, then the
% first @var{p} entries in @var{y} will be filled with these values. If
% @var{opt} is the string 'nodelay', then the first value of @var{y}
% corresponds to the first value of @var{x}. 
% 
% In the can of an underlap, @var{opt} must be an integer between 0 and
% @code{-@var{p}}. The represents the initial underlap of the first
% column of @var{y}.
%
% The default value for @var{opt} the vector @code{zeros (1, @var{p})}
% in the case of an overlap, or 0 otherwise.
% @end table
%
% In the case of a single output argument, @var{y} will be padded with
% zeros to fill the missing values in the data frame. With two output
% arguments @var{z} is the remaining data that has not been used in the
% current data frame.
%
% Likewise, the output @var{opt} is the overlap, or underlap that might
% be used for a future call to @code{code} to allow continuous buffering.
% @end deftypefn

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Sat 16-May-2009 00:04:49 by m2html © 2003