view scripts/plot/util/__default_plot_options__.m @ 29107:f8afcf772ba0

__default_plot_options__.m: Document function and improve performance. * __default_plot_options__.m: Document function. Use single call to struct() which saves 30 milliseconds for me or -19% on execution time.
author Rik <rik@octave.org>
date Thu, 26 Nov 2020 18:39:22 -0800
parents bd51beb6205e
children 44c253973f0f
line wrap: on
line source

########################################################################
##
## Copyright (C) 2007-2020 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## 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
## <https://www.gnu.org/licenses/>.
##
########################################################################

## -*- texinfo -*-
## @deftypefn {} {@var{options} =} __default_plot_options__ ()
## Return a plot options structure @var{options} with default values
## for all fields.
## @end deftypefn

function options = __default_plot_options__ ()

  options = struct ("key", "",
                    "color", [],
                    "linestyle", [],
                    "marker", [],
                    "errorstytle", []);

endfunction


%!test
%! options = __default_plot_options__ ();
%! assert (isfield (options, "key"));
%! assert (options.key, "");
%! assert (options.color, []);
%! assert (options.linestyle, []);
%! assert (options.marker, []);
%! assert (options.errorstyle, []);