octave: liboctave/util/oct-refcount.h annotate

annotate liboctave/util/oct-refcount.h @ 30564:796f54d4ddbf stable

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2021. In all .txi and .texi files except gpl.txi and gpl.texi in the doc/liboctave and doc/interpreter directories, change the copyright to "Octave Project Developers", the same as used for other source files. Update copyright notices for 2022 (not done since 2019). For gpl.txi and gpl.texi, change the copyright notice to be "Free Software Foundation, Inc." and leave the date at 2007 only because this file only contains the text of the GPL, not anything created by the Octave Project Developers. Add Paul Thomas to contributors.in.

author	John W. Eaton <jwe@octave.org>
date	Tue, 28 Dec 2021 18:22:40 -0500
parents	0a5b15007766
children	e88a07dec498

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ////////////////////////////////////////////////////////////////////////
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 //
30564 796f54d4ddbf update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	3 // Copyright (C) 2012-2022 The Octave Project Developers
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	4 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	7 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	9 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	14 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	19 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ////////////////////////////////////////////////////////////////////////
12125 a21a3875ca83 implement a common class for reference counts Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	25
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 19697 diff changeset	26 #if ! defined (octave_oct_refcount_h)
17822 ebb3ef964372 maint: Use common #define syntax "octave_filename_h" in h_files. Rik <rik@octave.org> parents: 17769 diff changeset	27 #define octave_oct_refcount_h 1
12125 a21a3875ca83 implement a common class for reference counts Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	28
21240 7af5ca01ecac allow octave-config.h to be included unconditionally John W. Eaton <jwe@octave.org> parents: 21229 diff changeset	29 #include "octave-config.h"
13985 43cc49c7abd1 Use thread-safe atomic reference counting (GCC and MSVC). Michael Goffioul <michael.goffioul@gmail.com> parents: 12174 diff changeset	30
27447 396996f1dad0 use std::atomic to implement refcount class John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	31 #include <atomic>
13985 43cc49c7abd1 Use thread-safe atomic reference counting (GCC and MSVC). Michael Goffioul <michael.goffioul@gmail.com> parents: 12174 diff changeset	32
23012 27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	33 namespace octave
12125 a21a3875ca83 implement a common class for reference counts Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	34 {
23012 27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	35 // Encapsulates a reference counter.
22381 6eba7555794a style fixes John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	36
23012 27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	37 template <typename T>
27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	38 class refcount
27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	39 {
27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	40 public:
27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	41
27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	42 typedef T count_type;
12125 a21a3875ca83 implement a common class for reference counts Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	43
23012 27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	44 refcount (count_type initial_count)
27177 8498dccc15c7 minor style fixes John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	45 : m_count (initial_count)
23012 27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	46 { }
12125 a21a3875ca83 implement a common class for reference counts Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	47
27447 396996f1dad0 use std::atomic to implement refcount class John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	48 refcount (const refcount&) = delete;
396996f1dad0 use std::atomic to implement refcount class John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	49
396996f1dad0 use std::atomic to implement refcount class John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	50 refcount& operator = (const refcount&) = delete;
396996f1dad0 use std::atomic to implement refcount class John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	51
396996f1dad0 use std::atomic to implement refcount class John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	52 ~refcount (void) = default;
396996f1dad0 use std::atomic to implement refcount class John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	53
23012 27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	54 // Increment/Decrement. int is postfix.
27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	55 count_type operator++ (void)
27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	56 {
27447 396996f1dad0 use std::atomic to implement refcount class John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	57 return ++m_count;
23012 27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	58 }
12125 a21a3875ca83 implement a common class for reference counts Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	59
23012 27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	60 count_type operator++ (int)
27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	61 {
27447 396996f1dad0 use std::atomic to implement refcount class John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	62 return m_count++;
23012 27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	63 }
12125 a21a3875ca83 implement a common class for reference counts Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	64
23012 27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	65 count_type operator-- (void)
27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	66 {
27447 396996f1dad0 use std::atomic to implement refcount class John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	67 return --m_count;
23012 27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	68 }
12125 a21a3875ca83 implement a common class for reference counts Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	69
23012 27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	70 count_type operator-- (int)
27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	71 {
27447 396996f1dad0 use std::atomic to implement refcount class John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	72 return m_count--;
23012 27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	73 }
12125 a21a3875ca83 implement a common class for reference counts Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	74
23679 ece6f43304e5 new function to convert dim_vector to Array<octave_idx_type> John W. Eaton <jwe@octave.org> parents: 23615 diff changeset	75 count_type value (void) const
ece6f43304e5 new function to convert dim_vector to Array<octave_idx_type> John W. Eaton <jwe@octave.org> parents: 23615 diff changeset	76 {
27447 396996f1dad0 use std::atomic to implement refcount class John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	77 return m_count.load ();
23679 ece6f43304e5 new function to convert dim_vector to Array<octave_idx_type> John W. Eaton <jwe@octave.org> parents: 23615 diff changeset	78 }
ece6f43304e5 new function to convert dim_vector to Array<octave_idx_type> John W. Eaton <jwe@octave.org> parents: 23615 diff changeset	79
23012 27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	80 operator count_type (void) const
27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	81 {
23679 ece6f43304e5 new function to convert dim_vector to Array<octave_idx_type> John W. Eaton <jwe@octave.org> parents: 23615 diff changeset	82 return value ();
23012 27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	83 }
12125 a21a3875ca83 implement a common class for reference counts Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	84
23012 27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	85 private:
14951 4c9fd3e31436 Start of jit support for double matricies Max Brister <max@2bass.com> parents: 14138 diff changeset	86
27447 396996f1dad0 use std::atomic to implement refcount class John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	87 std::atomic<T> m_count;
23012 27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	88 };
27e4ec3b0b49 move octave_refcount inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	89 }
22381 6eba7555794a style fixes John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	90
12125 a21a3875ca83 implement a common class for reference counts Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	91 #endif

Mercurial > octave

annotate liboctave/util/oct-refcount.h @ 30564:796f54d4ddbf stable