% -*- texinfo -*-
% @deftypefn {Function File} {[@var{num}, @var{rate}] = } biterr (@var{a},@var{b})
% @deftypefnx {Function File} {[@var{num}, @var{rate}] = } biterr (@var{...},@var{k})
% @deftypefnx {Function File} {[@var{num}, @var{rate}] = } biterr (@var{...},@var{flag})
% @deftypefnx {Function File} {[@var{num}, @var{rate} @var{ind}] = } biterr (@var{...})
%
% Compares two matrices and returns the number of bit errors and the bit
% error rate. The binary representations of the variables @var{a} and
% @var{b} are treated and @var{a} and @var{b} can be either:
%
% @table @asis
% @item Both matrices
% In this case both matrices must be the same size and then by default the
% the return values @var{num} and @var{rate} are the overall number of bit
% errors and the overall bit error rate.
% @item One column vector
% In this case the column vector is used for bit error comparision column-wise
% with the matrix. The returned values @var{num} and @var{rate} are then
% row vectors containing the num of bit errors and the bit error rate for
% each of the column-wise comparisons. The number of rows in the matrix
% must be the same as the length of the column vector
% @item One row vector
% In this case the row vector is used for bit error comparision row-wise
% with the matrix. The returned values @var{num} and @var{rate} are then
% column vectors containing the num of bit errors and the bit error rate for
% each of the row-wise comparisons. The number of columns in the matrix
% must be the same as the length of the row vector
% @end table
%
% This behaviour can be overridden with the variable @var{flag}. @var{flag}
% can take the value 'column-wise', 'row-wise' or 'overall'. A column-wise
% comparision is not possible with a row vector and visa-versa.
%
% By default the number of bits in each symbol is assumed to be give by the
% number required to represent the maximum value of @var{a} and @var{b}.
% The number of bits to represent a symbol can be overridden by the variable
% @var{k}.
% @end deftypefn