Mercurial > octave
view libinterp/octave-value/ov-base-scalar.h @ 27918:b442ec6dda5c
use centralized file for copyright info for individual contributors
* COPYRIGHT.md: New file.
* In most other files, use "Copyright (C) YYYY-YYYY The Octave Project
Developers" instead of tracking individual names in separate source
files. The motivation is to reduce the effort required to update the
notices each year.
Until now, the Octave source files contained copyright notices that
list individual contributors. I adopted these file-scope copyright
notices because that is what everyone was doing 30 years ago in the
days before distributed version control systems. But now, with many
contributors and modern version control systems, having these
file-scope copyright notices causes trouble when we update copyright
years or refactor code.
Over time, the file-scope copyright notices may become outdated as new
contributions are made or code is moved from one file to
another. Sometimes people contribute significant patches but do not
add a line claiming copyright. Other times, people add a copyright
notice for their contribution but then a later refactoring moves part
or all of their contribution to another file and the notice is not
moved with the code. As a practical matter, moving such notices is
difficult -- determining what parts are due to a particular
contributor requires a time-consuming search through the project
history. Even managing the yearly update of copyright years is
problematic. We have some contributors who are no longer
living. Should we update the copyright dates for their contributions
when we release new versions? Probably not, but we do still want to
claim copyright for the project as a whole.
To minimize the difficulty of maintaining the copyright notices, I
would like to change Octave's sources to use what is described here:
https://softwarefreedom.org/resources/2012/ManagingCopyrightInformation.html
in the section "Maintaining centralized copyright notices":
The centralized notice approach consolidates all copyright
notices in a single location, usually a top-level file.
This file should contain all of the copyright notices
provided project contributors, unless the contribution was
clearly insignificant. It may also credit -- without a copyright
notice -- anyone who helped with the project but did not
contribute code or other copyrighted material.
This approach captures less information about contributions
within individual files, recognizing that the DVCS is better
equipped to record those details. As we mentioned before, it
does have one disadvantage as compared to the file-scope
approach: if a single file is separated from the distribution,
the recipient won't see the contributors' copyright notices.
But this can be easily remedied by including a single
copyright notice in each file's header, pointing to the
top-level file:
Copyright YYYY-YYYY The Octave Project Developers
See the COPYRIGHT file at the top-level directory
of this distribution or at https://octave.org/COPYRIGHT.html.
followed by the usual GPL copyright statement.
For more background, see the discussion here:
https://lists.gnu.org/archive/html/octave-maintainers/2020-01/msg00009.html
Most files in the following directories have been skipped intentinally
in this changeset:
doc
libgui/qterminal
liboctave/external
m4
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Mon, 06 Jan 2020 15:38:17 -0500 |
parents | 9cd4b045fe3d |
children | 1891570abac8 |
line wrap: on
line source
/* Copyright (C) 1996-2019 The Octave Project Developers See the file COPYRIGHT.md in the top-level directory of this distribution or <https://octave.org/COPYRIGHT.html/>. 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/>. */ #if ! defined (octave_ov_base_scalar_h) #define octave_ov_base_scalar_h 1 #include "octave-config.h" #include <cstdlib> #include <iosfwd> #include <string> #include "lo-mappers.h" #include "lo-utils.h" #include "str-vec.h" #include "MatrixType.h" #include "ov-base.h" #include "ov-typeinfo.h" // Real scalar values. template <typename ST> class octave_base_scalar : public octave_base_value { public: octave_base_scalar (void) : octave_base_value (), scalar () { } octave_base_scalar (const ST& s) : octave_base_value (), scalar (s) { } octave_base_scalar (const octave_base_scalar& s) : octave_base_value (), scalar (s.scalar) { } ~octave_base_scalar (void) = default; octave_value squeeze (void) const { return scalar; } octave_value full_value (void) const { return scalar; } // We don't need to override all three forms of subsref. The using // declaration will avoid warnings about partially-overloaded virtual // functions. using octave_base_value::subsref; octave_value subsref (const std::string& type, const std::list<octave_value_list>& idx); octave_value_list subsref (const std::string& type, const std::list<octave_value_list>& idx, int) { return subsref (type, idx); } octave_value subsasgn (const std::string& type, const std::list<octave_value_list>& idx, const octave_value& rhs); bool is_constant (void) const { return true; } bool is_defined (void) const { return true; } dim_vector dims (void) const; octave_idx_type numel (void) const { return 1; } int ndims (void) const { return 2; } octave_idx_type nnz (void) const { return (scalar != ST () ? 1 : 0); } octave_value permute (const Array<int>&, bool = false) const; octave_value reshape (const dim_vector& new_dims) const; size_t byte_size (void) const { return sizeof (ST); } octave_value all (int = 0) const { return (scalar != ST ()); } octave_value any (int = 0) const { return (scalar != ST ()); } octave_value diag (octave_idx_type k = 0) const; octave_value diag (octave_idx_type m, octave_idx_type n) const; octave_value sort (octave_idx_type, sortmode) const { return octave_value (scalar); } octave_value sort (Array<octave_idx_type> &sidx, octave_idx_type, sortmode) const { sidx.resize (dim_vector (1, 1)); sidx(0) = 0; return octave_value (scalar); } sortmode issorted (sortmode mode = UNSORTED) const { return mode == UNSORTED ? ASCENDING : mode; } Array<octave_idx_type> sort_rows_idx (sortmode) const { return Array<octave_idx_type> (dim_vector (1, 1), static_cast<octave_idx_type> (0)); } sortmode is_sorted_rows (sortmode mode = UNSORTED) const { return mode == UNSORTED ? ASCENDING : mode; } MatrixType matrix_type (void) const { return MatrixType::Diagonal; } MatrixType matrix_type (const MatrixType&) const { return matrix_type (); } bool is_scalar_type (void) const { return true; } bool isnumeric (void) const { return true; } bool is_true (void) const; void print (std::ostream& os, bool pr_as_read_syntax = false); void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const; bool print_name_tag (std::ostream& os, const std::string& name) const; void short_disp (std::ostream& os) const; float_display_format get_edit_display_format (void) const; std::string edit_display (const float_display_format& fmt, octave_idx_type i, octave_idx_type j) const; // Unsafe. This function exists to support the MEX interface. // You should not use it anywhere else. void * mex_get_data (void) const { return const_cast<ST *> (&scalar); } const ST& scalar_ref (void) const { return scalar; } ST& scalar_ref (void) { return scalar; } octave_value fast_elem_extract (octave_idx_type n) const; bool fast_elem_insert_self (void *where, builtin_type_t btyp) const; protected: // The value of this scalar. ST scalar; }; #endif