view scripts/java/javaArray.m @ 20160:03b9d17a2d95 stable

doc: Update more docstrings to have one sentence summary as first line. Reviewed io, java, linear-algebra, prefs, and set script directories. * scripts/io/beep.m, scripts/io/dlmwrite.m, scripts/io/importdata.m, scripts/io/strread.m, scripts/io/textread.m, scripts/java/javaArray.m, scripts/java/java_get.m, scripts/java/java_set.m, scripts/java/javaaddpath.m, scripts/java/javachk.m, scripts/java/javaclasspath.m, scripts/java/javamem.m, scripts/java/javarmpath.m, scripts/linear-algebra/bandwidth.m, scripts/linear-algebra/commutation_matrix.m, scripts/linear-algebra/cond.m, scripts/linear-algebra/condest.m, scripts/linear-algebra/cross.m, scripts/linear-algebra/duplication_matrix.m, scripts/linear-algebra/expm.m, scripts/linear-algebra/housh.m, scripts/linear-algebra/isdefinite.m, scripts/linear-algebra/ishermitian.m, scripts/linear-algebra/issymmetric.m, scripts/linear-algebra/istril.m, scripts/linear-algebra/istriu.m, scripts/linear-algebra/krylov.m, scripts/linear-algebra/logm.m, scripts/linear-algebra/normest.m, scripts/linear-algebra/null.m, scripts/linear-algebra/onenormest.m, scripts/linear-algebra/orth.m, scripts/linear-algebra/qzhess.m, scripts/linear-algebra/rank.m, scripts/linear-algebra/rref.m, scripts/linear-algebra/vech.m, scripts/path/matlabroot.m, scripts/prefs/addpref.m, scripts/prefs/getpref.m, scripts/prefs/ispref.m, scripts/prefs/rmpref.m, scripts/prefs/setpref.m, scripts/set/powerset.m, scripts/set/setdiff.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sun, 03 May 2015 15:36:23 -0700
parents d63878346099
children
line wrap: on
line source

## Copyright (C) 2007, 2013 Michael Goffioul
##
## 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} {@var{jary} =} javaArray (@var{classname}, @var{sz})
## @deftypefnx {Function File} {@var{jary} =} javaArray (@var{classname}, @var{m}, @var{n}, @dots{})
##
## Create a Java array of size @var{sz} with elements of class @var{classname}.
##
## @var{classname} may be a Java object representing a class or a string
## containing the fully qualified class name.  The size of the object may
## also be specified with individual integer arguments @var{m}, @var{n}, etc.
##
## The generated array is uninitialized.  All elements are set to null if
## @var{classname} is a reference type, or to a default value (usually 0) if
## @var{classname} is a primitive type.
##
## Sample code:
##
## @example
## @group
## jary = javaArray ("java.lang.String", 2, 2);
## jary(1,1) = "Hello";
## @end group
## @end example
## @seealso{javaObject}
## @end deftypefn

function retval = javaArray (classname, varargin)

  if (nargin < 2)
    print_usage ();
  endif

  retval = javaMethod ("createArray", "org.octave.ClassHelper",
                        classname, [varargin{:}]);

endfunction