Mercurial > hg > octave-lyh
view scripts/statistics/base/logit.m @ 9051:1bf0ce0930be
Grammar check TexInfo in all .m files
Cleanup documentation sources to follow a few consistent rules.
Spellcheck was NOT done. (but will be in another changeset)
author | Rik <rdrider0-list@yahoo.com> |
---|---|
date | Fri, 27 Mar 2009 22:31:03 -0700 |
parents | a1dbe9d80eee |
children | f0c3d3fc4903 |
line wrap: on
line source
## Copyright (C) 1995, 1996, 1997, 1998, 2000, 2002, 2005, 2006, 2007 ## Kurt Hornik ## ## This file is part of Octave. ## ## Octave 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. ## ## Octave 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 Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} logit (@var{p}) ## For each component of @var{p}, return the logit of @var{p} defined as ## @iftex ## @tex ## $$ ## {\rm logit}(p) = \log\Big({p \over 1-p}\Big) ## $$ ## @end tex ## @end iftex ## @ifnottex ## @example ## logit(@var{p}) = log (@var{p} / (1-@var{p})) ## @end example ## @end ifnottex ## @end deftypefn ## Author: KH <Kurt.Hornik@wu-wien.ac.at> ## Description: Logit transformation function y = logit (p) if (nargin == 1) y = logistic_inv (p); else print_usage (); endif endfunction