nlib
manual_en_z.h
1 
2 #include "nn/nlib/Platform.h"
3 
4 namespace nn {
5 namespace nlib {
6 
8 class z {
9 public:
11  z() noexcept; // \copybrief z::z()
13  void z_needs_init() noexcept; // \copybrief z::z_needs_init()
15  ~z() noexcept; // \copybrief z::~z()
17  z(z&&) noexcept; // \copybrief z::z(z&&)
19  z& operator=(z&&) noexcept; // \copybrief z::operator=(z&&)
21  z(const z&) noexcept; // \copybrief z::z(const z&)
23  z& operator=(const z&) noexcept; // \copybrief z::operator=(const z&)
25  errno_t Init() noexcept; // \copybrief z::Init()
27  bool InitB() noexcept; // \copybrief z::InitB()
28 
29  //unsage \copydoc z::Init_settings()
36  errno_t Init_settings(const z& settings) noexcept;
37 
39  void Overload_omitarg() noexcept; // \copybrief z::Overload_omitarg()
41  void Overload_omitarg_null() noexcept; // \copybrief z::Overload_omitarg_null()
43  void Overload_omitarg_false() noexcept; // \copybrief z::Overload_omitarg_false()
45  void Overload_omitarg_settings() noexcept; // \copybrief z::Overload_omitarg_settings()
47  void Overload_omitarg_template() noexcept; // \copybrief z::Overload_omitarg_template()
49  void Overload_omitarg_cstr() noexcept; // \copybrief z::Overload_omitarg_cstr()
50 
51 
53  void Overload_const() const noexcept; // \copybrief z::Overload_const()
54 
56  void Reset() noexcept; // \copybrief z::Reset()
57 
58  //
59  // iterators
60  //
61 
63  void iterator() noexcept; // \copybrief z::iterator()
65  void const_iterator() noexcept; // \copybrief z::const_iterator()
67  void forward_iterator() noexcept; // \copybrief z::forward_iterator()
69  void const_forward_iterator() noexcept; // \copybrief z::const_forward_iterator()
71  void reverse_iterator() noexcept; // \copybrief z::reverse_iterator()
73  void const_reverse_iterator() noexcept; // \copybrief z::const_reverse_iterator()
74 
76  void reference() noexcept; // \copybrief z::reference()
78  void const_reference() noexcept; // \copybrief z::const_reference()
80  void pointer() noexcept; // \copybrief z::pointer()
82  void const_pointer() noexcept; // \copybrief z::const_pointer()
83 
85  void begin() noexcept; // \copybrief z::begin()
87  void begin_const() const noexcept; // \copybrief z::begin_const()
89  void end() noexcept; // \copybrief z::end()
91  void end_const() const noexcept; // \copybrief z::end_const()
93  void rbegin() noexcept; // \copybrief z::rbegin()
95  void rbegin_const() const noexcept; // \copybrief z::rbegin_const()
97  void rend() noexcept; // \copybrief z::rend()
99  void rend_const() const noexcept; // \copybrief z::rend_const()
100 
102  void front() noexcept; // \copybrief z::front()
104  void back() noexcept; // \copybrief z::back()
105 
109  int& at(size_t n) noexcept; // \copydoc z::at()
110 
112  size_t size() const noexcept; // \copybrief z::size()
114  bool empty() const noexcept; // \copybrief z::empty()
115 
117  bool opbool() const noexcept; // \copybrief z::opbool()
118 
120  bool opbool_err() const noexcept; // \copybrief z::opbool_err()
121 };
122 
124 bool opeq(const z& lhs, const z& rhs); // \copybrief opeq()
126 bool opne(const z& lhs, const z& rhs); // \copybrief opne()
128 bool oplt(const z& lhs, const z& rhs); // \copybrief oplt()
130 bool opgt(const z& lhs, const z& rhs); // \copybrief opgt()
132 bool ople(const z& lhs, const z& rhs); // \copybrief ople()
134 bool opge(const z& lhs, const z& rhs); // \copybrief opge()
135 
136 //
137 // for member group(@name)
138 //
139 // FILTER_ATNAME_CTORDTOR: Constructor, Destructor, and Initialization
140 // FILTER_ATNAME_OPENCLOSE: Open and Close
141 // FILTER_ATNAME_GETSET: Acquisition and Setting of Internal Status
142 //
143 }
144 }
void front() noexcept
Gets a reference to the first element.
bool opne(const z &lhs, const z &rhs)
Performs an inequality comparison.
errno_t Init_settings(const z &settings) noexcept
Initializes by specifying the behavior option. Returns 0 if successful.
void begin_const() const noexcept
Gets the read-only iterator pointing to the first element.
bool opbool() const noexcept
Returns true if the object is in a valid status, or returns false otherwise.
void const_pointer() noexcept
Read-only pointer to an element.
void const_reference() noexcept
Read-only reference to an element.
void pointer() noexcept
Pointer to the element.
errno_t Init() noexcept
Initializes an object. Returns 0 if successful.
void back() noexcept
Gets a reference to the last element.
bool empty() const noexcept
Returns true if the number of stored elements is 0, or returns false otherwise.
void end() noexcept
Gets the iterator pointing beyond the last element.
Definition: Base64.h:25
bool opbool_err() const noexcept
Returns true if the object has been initialized and an error has not occurred inside, or returns false if an error has occurred inside.
size_t size() const noexcept
Returns the number of stored elements.
void Overload_omitarg_template() noexcept
A template overload of the above function.
bool oplt(const z &lhs, const z &rhs)
Returns true if the left side is smaller than the right side, or returns false otherwise.
void Overload_omitarg_false() noexcept
A parameter omitted version of the above function which passes false as a parameter.
z() noexcept
Instantiates the object with default parameters (default constructor).
Basic APIs are declared with a C linkage.
void Overload_omitarg_settings() noexcept
A parameter omitted version of the above function which passes settings as the default value...
void rbegin_const() const noexcept
Gets the read-only reverse iterator pointing to the last element.
z & operator=(z &&) noexcept
Move assignment operator.
void forward_iterator() noexcept
A forward iterator.
void const_iterator() noexcept
Read-only random-access iterator.
bool opgt(const z &lhs, const z &rhs)
Returns true if the right side is smaller than the left side, or returns false otherwise.
bool InitB() noexcept
Initializes an object. Returns true if successful.
bool ople(const z &lhs, const z &rhs)
Returns true if the left side is equal to or smaller than the right side, or returns false otherwise...
A dummy class provided for the convenience of creating a document, which does not exist...
Definition: manual_en_z.h:8
void z_needs_init() noexcept
Instantiates the object with default parameters (default constructor). Requires initialization with I...
void reference() noexcept
A reference to an element.
void Overload_omitarg() noexcept
A parameter omitted version of the above function.
void iterator() noexcept
A random-access iterator.
void rend() noexcept
Gets the reverse iterator pointing ahead of the first element.
void const_forward_iterator() noexcept
Read-only forward iterator.
void end_const() const noexcept
Gets the read-only iterator pointing beyond the last element.
~z() noexcept
Destructor.
void rbegin() noexcept
Gets the reverse iterator pointing to the last element.
bool opeq(const z &lhs, const z &rhs)
Performs an equality comparison.
void reverse_iterator() noexcept
A reverse iterator.
int & at(size_t n) noexcept
Gets the nth element. n must be less than the number of stored elements.
void Overload_omitarg_cstr() noexcept
A parameter omitted version of the above function which receives a null terminated string...
void Overload_omitarg_null() noexcept
A parameter omitted version of the above function which passes nullptr as a parameter.
void Overload_const() const noexcept
The const decoration version of the above function.
bool opge(const z &lhs, const z &rhs)
Returns true if the right side is equal to or smaller than the left side, or returns false otherwise...
void rend_const() const noexcept
Gets the read-only reverse iterator pointing ahead of the first element.
void const_reverse_iterator() noexcept
Read-only reverse iterator.
void begin() noexcept
Gets the iterator pointing to the first element.
void Reset() noexcept
Resets this object to the state immediately after the default constructor was executed.
int errno_t
Indicates with an int-type typedef that a POSIX error value is returned as the return value...
Definition: NMalloc.h:37