Mo Logo [Home] [Lexikon] [Aufgaben] [Tests] [Kurse] [Begleitmaterial] [Hinweise] [Mitwirkende] [Publikationen]

Mathematik-Online-Kurs: MATLAB - Grundlagen

Das Hilfe-System von MATLAB


[vorangehende Seite] [nachfolgende Seite] [Gesamtverzeichnis][Seitenübersicht]

Der Befehl help dient zur Anzeige von Hilfetexten im Kommandofenster. Mögliche Aufrufarten sind dabei:
help     bzw.      help Thema     bzw.      help Funktionsname
die eine Übersicht aller Hilfethemen bzw. die Hilfe zu einem Thema bzw. einer Funktion ausgibt.

Sofern der Funktionsname nicht bekannt ist, kann mittels

lookfor Text
nach den Funktionen gesucht werden, in deren Kurzbeschribung der gegebene Text enthalten ist.

Ebenfalls verfügbar ist eine Dokumentation in HTML-Format. Diese kann mit Hilfe des Befehls

helpbrowser
angezeigt werden. Einzelne Funktions- oder Themenbeschreibungen können analog zu help mit Hilfe des Befehle
doc Thema     bzw.     doc Funktionsname
im Helpbrowser angezeigt werden.

Der Helpbrowser ermöglicht über den Reiter ,,Demos`` auch den Zugang zu vielen Anwendungsbeispielen. Diese können alternativ auch durch Eingabe von demo auf der Kommandozeile aufgrufen werden.

Bei den Hilfe- und Dokumentationstexten ist darauf zu achten, dass Funktionsnamen zur besseren Kennzeichnung mit Großbuchstaben dargestellt sind. Beim Aufruf der Funktion oder der zugehörigen Hilfeseiten sind jedoch Kleinbuchstaben zu verwenden.

(Autoren: Hörner/Wipper)

Gesucht wird der Befehl zur Berechnung des Rangs (engl. rank) einer Matrix. Hierzu wird zunächst mit Hilfe der Funktion lookfor nach jenen Funktionen gesucht, in deren Kurzbeschreibung die Zeichenkette rank vorkommt:
  >> lookfor rank
  CHOLUPDATE Rank 1 update to Cholesky factorization.
  QRUPDATE Rank 1 update to QR factorization.
  RANK   Matrix rank.
  SPRANK Structural rank.
  GFRANK Compute the rank of a matrix over a Galois field.
  FITSCALINGRANK Rank based fitness scaling.
  GANGSTR Zero out 'small' entries subject to structural rank.
  FRANKE Franke's bivariate test function.
  ...
Jede Zeile der Ausgabe von lookfor enthält den groß geschriebenen Namen und die Kurzbeschreibung einer Funktion. Die Anzeige der Hilfeseite zur Funktion rank erfolgt mit dem Befehl help (auf Kleinschreibung des Funktionsnamens achten).
  >> help rank
   RANK   Matrix rank.
      RANK(A) provides an estimate of the number of linearly
      independent rows or columns of a matrix A.
      RANK(A,tol) is the number of singular values of A
      that are larger than tol.
      RANK(A) uses the default tol = max(size(A)) * eps(norm(A)).
   
      Class support for input A:
         float: double, single
  
      Overloaded functions or methods (ones with the same name in 
           other directories)
         help gf/rank.m
         help sym/rank.m
  
      Reference page in Help browser
         doc rank
Eine ausführliche Beschreibung der Funktion rank im Hilfe-Browser kann durch Eingabe von doc rank angezeigt werden:

Viele MATLAB-Funktionen sind in der Programmiersprache von MATLAB implementiert. Der Quelltext kann in diesem Fall mit type  Funktionsname angezeigt werden:

  >> type rank
  
  function r = rank(A,tol)
  %RANK   Matrix rank.
  %   RANK(A) provides an estimate of the number of linearly
  %   independent rows or columns of a matrix A.
  %   RANK(A,tol) is the number of singular values of A
  %   that are larger than tol.
  %   RANK(A) uses the default tol = max(size(A)) * eps(norm(A)).
  %
  %   Class support for input A:
  %      float: double, single
  
  %   Copyright 1984-2004 The MathWorks, Inc.
  %   $Revision: 1.5 $  $Date: 2006/08/22 09:08:13 $
  
  s = svd(A);
  if nargin==1
     tol = max(size(A)') * eps(max(s));
  end
  r = sum(s > tol);
Die mittels help ausgegebene Hilfe zur Funktion rank entspricht dabei dem ersten zusammenhängenden Block von Kommentarzeilen, die durch % gekennzeichnet sind. Die Funktion lookfor durchsucht die jeweils erste Kommentarzeile.
(Autoren: Hörner/Wipper)

[vorangehende Seite] [nachfolgende Seite] [Gesamtverzeichnis][Seitenübersicht]

  automatisch erstellt am 5.2.2008