#include <Span.h>
Public Member Functions | |
| Span (const T &begin, const T &end, bool relaxed=false) | |
| Constructor. More... | |
| virtual int | compare (const Object &rhs) const |
| Compare with another object. More... | |
| virtual void | copy (const Object &rhs) |
| Copy another instance. More... | |
| virtual void | serialize (Stream &stream, uint_t io, uint_t mode=ser_default) |
| Serialize to or from a stream. More... | |
| virtual String | toString () const |
| Return a string representation of self. More... | |
| Span< T, D > & | clip (const Span< T, D > &span) |
| Clip against the given span. More... | |
| Span< T, D > & | clipBegin (const T &t) |
| Clip the beginning against the given value. More... | |
| Span< T, D > & | clipEnd (const T &t) |
| Clip the end against the given value. More... | |
| bool | contains (const Span< T, D > &span) const |
| Determine whether self contains the given span. More... | |
| bool | contains (const T &v) const |
| Determine whether self contains the given value. More... | |
| bool | isContainedBy (const Span< T, D > &span) const |
| Determine whether self is contained by the given span. More... | |
| void | merge (const Span< T, D > &span) |
| Merge with the given span. More... | |
| Span< T, D > | overlap (const Span< T, D > &span) const |
| Return the sub-span that overlaps with the given span. More... | |
| bool | overlaps (const Span< T, D > &span) const |
| Determine whether self overlaps with the given span. More... | |
| D | overlapSize (const Span< T, D > &span) const |
| Return the length of the overlap with the given span. More... | |
| Span< T, D > | remove (const Span< T, D > &span) |
| Remove the given span from self. More... | |
| Span< T, D > | operator+ (const Span< T, D > &rhs) |
| Return self merged with the given span. More... | |
| const Span< T, D > & | operator+= (const Span< T, D > &rhs) |
| Merge with the given span. More... | |
Accessors. | |
| const T & | begin () const |
| Get the beginning of the span. More... | |
| void | setBegin (const T &begin) |
| Set the beginning of the span. More... | |
| const T & | end () const |
| Get the end of the span. More... | |
| void | setEnd (const T &end) |
| Set the end of the span. More... | |
| void | set (const T &begin, const T &end) |
| Set the beginning and end of the span. More... | |
| bool | isNil () const |
| Determine whether the span is nil. More... | |
| void | setNil () |
| Set the span to nil. More... | |
| bool | isRelaxed () const |
| Get the relaxed flag. More... | |
| void | setRelaxed (bool relaxed) |
| Set the relaxed flag. More... | |
| D | size () const |
| Return the size (end - begin). More... | |
 Public Member Functions inherited from utl::Object | |
| void | clear () |
| Revert to initial state. More... | |
| virtual void | vclone (const Object &rhs) |
| Make an exact copy of another instance. More... | |
| virtual void | steal (Object &rhs) |
| "Steal" the internal representation from another instance. More... | |
| virtual void | dump (Stream &os, uint_t level=uint_t_max) const |
| Dump a human-readable representation of self to the given output stream. More... | |
| void | dumpWithClassName (Stream &os, uint_t indent=4, uint_t level=uint_t_max) const |
| Front-end for dump() that prints the object's class name. More... | |
| virtual const Object & | getKey () const |
| Get the key for this object. More... | |
| bool | hasKey () const |
| Determine whether or not the object has a key. More... | |
| virtual const Object & | getProxiedObject () const |
| Get the proxied object (= self if none). More... | |
| virtual Object & | getProxiedObject () |
| Get the proxied object (= self if none). More... | |
| virtual size_t | hash (size_t size) const |
| Get the hash code for the object. More... | |
| bool | _isA (const RunTimeClass *runTimeClass) const |
| Determine whether self's class is a descendent of the given class. More... | |
| operator String () const | |
| Conversion to String. More... | |
| size_t | allocatedSize () const |
| Get the total allocated size of this object. More... | |
| virtual size_t | innerAllocatedSize () const |
| Get the "inner" allocated size. More... | |
| virtual void | addOwnedIt (const class FwdIt *it) const |
| Notify self that it owns the given iterator. More... | |
| virtual void | removeOwnedIt (const class FwdIt *it) const |
| Notify self that the given owned iterator has been destroyed. More... | |
| bool | operator< (const Object &rhs) const |
| Less-than operator. More... | |
| bool | operator<= (const Object &rhs) const |
| Less-than-or-equal-to operator. More... | |
| bool | operator> (const Object &rhs) const |
| Greater-than operator. More... | |
| bool | operator>= (const Object &rhs) const |
| Greater-than-or-equal-to operator. More... | |
| bool | operator== (const Object &rhs) const |
| Equal-to operator. More... | |
| bool | operator!= (const Object &rhs) const |
| Unequal-to operator. More... | |
| void | serializeIn (Stream &is, uint_t mode=ser_default) |
| Serialize from an input stream. More... | |
| void | serializeOut (Stream &os, uint_t mode=ser_default) const |
| Serialize to an output stream. More... | |
| void | serializeOutBoxed (Stream &os, uint_t mode=ser_default) const |
| Serialize a boxed object to an output stream. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from utl::Object | |
| static Object * | serializeInNullable (Stream &is, uint_t mode=ser_default) |
| Serialize a nullptr-able object from an input stream. More... | |
| static void | serializeOutNullable (const Object *object, Stream &os, uint_t mode=ser_default) |
| Serialize a nullptr-able object to an output stream. More... | |
| static void | serializeNullable (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default) |
| Serialize a nullptr-able object to or from a stream. More... | |
| static Object * | serializeInBoxed (Stream &is, uint_t mode=ser_default) |
| Serialize a boxed object from an input stream. More... | |
| static void | serializeBoxed (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default) |
| Serialize a boxed object to or from a stream. More... | |
| Protected Member Functions inherited from utl::FlagsMI | |
| FlagsMI () | |
| Constructor. More... | |
| virtual | ~FlagsMI () |
| Destructor. More... | |
| void | copyFlags (const FlagsMI &rhs) |
| Copy the given flags. More... | |
| void | copyFlags (const FlagsMI &rhs, uint_t lsb, uint_t msb) |
| Copy (some of) the given flags. More... | |
| void | copyFlags (uint64_t flags, uint_t lsb, uint_t msb) |
| Copy (some of) the given flags. More... | |
| bool | getFlag (uint_t flagNum) const |
| Get a user-defined flag. More... | |
| void | setFlag (uint_t flagNum, bool val) |
| Set a user-defined flag. More... | |
| uint64_t | getFlagsNumber (uint64_t mask, uint64_t shift=0) |
| Get a multi-bit value in the flags data (which is stored as one 64-bit integer). More... | |
| void | setFlagsNumber (uint64_t mask, uint64_t shift, uint64_t num) |
| Set a multi-bit value in the flags data (which is stored as one 64-bit integer). More... | |
| uint64_t | getFlags () const |
| Get the flags. More... | |
| void | setFlags (uint64_t flags) |
| Set the flags. More... | |
Detailed Description
template<class T, class D = T>
class utl::Span< T, D >
Span of values.
A span is defined by its begin and end values. It includes all values greater than or equal to the begin value and less than the end value. We write a span like this: [begin, end).
Attributes
- relaxed flag : If true for either span involved in a comparison, the two spans are judged to be equal if they overlap.
Constructor & Destructor Documentation
◆ Span()
Member Function Documentation
◆ compare()
Compare with another object.
If no overridden version succeeds in doing the comparison, then an attempt will be made to re-start the comparison process using one or both of the objects' keys. Usually, an override of compare() should call the superclass's compare() if it doesn't know how to compare itself with the rhs object.
- See also
- getKey
- Returns
- < 0 if self < rhs, 0 if self = rhs, > 0 if self > rhs
- Parameters
-
rhs object to compare with
Reimplemented from utl::Object.
Reimplemented in utl::TimeSpan.
Definition at line 324 of file Span.h.
Referenced by utl::SpanSizeOrdering< T, D >::cmp().
◆ copy()
Copy another instance.
When you override copy(), you should usually call the superclass's copy().
- Parameters
-
rhs object to copy
Reimplemented from utl::Object.
◆ serialize()
|
virtual |
Serialize to or from a stream.
This is the only virtual method for serialization. You must override this in any class that has data to be serialized, and ensure that the superclass's serialize() gets called.
- Parameters
-
stream stream to serialize from/to io see utl::io_t mode see utl::serialize_t
Reimplemented from utl::Object.
Reimplemented in utl::ObjectSpan< T, D >, and utl::ObjectSpan< Time, Duration >.
◆ toString()
Return a string representation of self.
Reimplemented from utl::Object.
Reimplemented in utl::ObjectSpan< T, D >, and utl::ObjectSpan< Time, Duration >.
◆ begin()
|
inline |
Get the beginning of the span.
Definition at line 72 of file Span.h.
Referenced by utl::SpanAllocator< T, D >::alloc(), utl::Span< Time, Duration >::merge(), utl::Span< Time, Duration >::remove(), and utl::TimeSpan::TimeSpan().
◆ setBegin()
|
inline |
Set the beginning of the span.
Definition at line 79 of file Span.h.
Referenced by utl::SpanAllocator< T, D >::alloc(), and utl::Span< Time, Duration >::remove().
◆ end()
|
inline |
Get the end of the span.
Definition at line 86 of file Span.h.
Referenced by utl::Span< Time, Duration >::merge(), utl::Span< Time, Duration >::remove(), and utl::TimeSpan::TimeSpan().
◆ setEnd()
|
inline |
Set the end of the span.
Definition at line 93 of file Span.h.
Referenced by utl::SpanAllocator< T, D >::alloc(), and utl::Span< Time, Duration >::remove().
◆ set()
|
inline |
◆ isNil()
|
inline |
Determine whether the span is nil.
Definition at line 108 of file Span.h.
Referenced by utl::SpanCol< T, D >::add(), utl::SpanAllocator< T, D >::alloc(), and utl::Span< Time, Duration >::remove().
◆ setNil()
|
inline |
◆ isRelaxed()
|
inline |
◆ setRelaxed()
|
inline |
Set the relaxed flag.
Definition at line 129 of file Span.h.
Referenced by utl::SpanCol< T, D >::add(), and utl::SpanAllocator< T, D >::alloc().
◆ size()
|
inline |
Return the size (end - begin).
Definition at line 136 of file Span.h.
Referenced by utl::SpanCol< T, D >::add(), utl::SpanAllocator< T, D >::alloc(), and utl::SpanSizeOrdering< T, D >::cmp().
◆ clip()
◆ clipBegin()
◆ clipEnd()
◆ contains() [1/2]
|
inline |
Determine whether self contains the given span.
Definition at line 163 of file Span.h.
Referenced by utl::Span< Time, Duration >::isContainedBy(), and utl::Span< Time, Duration >::remove().
◆ contains() [2/2]
|
inline |
◆ isContainedBy()
◆ merge()
Merge with the given span.
Definition at line 184 of file Span.h.
Referenced by utl::SpanCol< T, D >::add(), and utl::Span< Time, Duration >::operator+().
◆ overlap()
| Span< T, D > utl::Span< T, D >::overlap | ( | const Span< T, D > & | span | ) | const |
Return the sub-span that overlaps with the given span.
Definition at line 400 of file Span.h.
Referenced by utl::SpanCol< T, D >::add(), and utl::Span< Time, Duration >::remove().
◆ overlaps()
◆ overlapSize()
◆ remove()
Remove the given span from self.
- Returns
- second remaining part of self (if self is bisected)
Definition at line 420 of file Span.h.
Referenced by utl::SpanCol< T, D >::add(), and utl::SpanAllocator< T, D >::alloc().
◆ operator+()
◆ operator+=()
The documentation for this class was generated from the following file:
