libUTL++
utl::Span< T, D > Class Template Reference

Span of values. More...

#include <Span.h>

Inheritance diagram for utl::Span< T, D >:

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...
 
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...
 
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 ObjectgetKey () const
 Get the key for this object. More...
 
bool hasKey () const
 Determine whether or not the object has a key. More...
 
virtual const ObjectgetProxiedObject () const
 Get the proxied object (= self if none). More...
 
virtual ObjectgetProxiedObject ()
 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 ObjectserializeInNullable (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 ObjectserializeInBoxed (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.
Author
Adam McKee

Definition at line 47 of file Span.h.

Constructor & Destructor Documentation

◆ Span()

template<class T, class D >
utl::Span< T, D >::Span ( const T &  begin,
const T &  end,
bool  relaxed = false 
)

Constructor.

Parameters
beginspan begin
endspan end
relaxedrelaxed comparisons?

Definition at line 313 of file Span.h.

Member Function Documentation

◆ compare()

template<class T , class D >
int utl::Span< T, D >::compare ( const Object rhs) const
virtual

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
rhsobject 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()

template<class T , class D >
void utl::Span< T, D >::copy ( const Object rhs)
virtual

Copy another instance.

When you override copy(), you should usually call the superclass's copy().

Parameters
rhsobject to copy

Reimplemented from utl::Object.

Definition at line 354 of file Span.h.

◆ serialize()

template<class T , class D >
void utl::Span< T, D >::serialize ( Stream stream,
uint_t  io,
uint_t  mode = ser_default 
)
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
streamstream to serialize from/to
iosee utl::io_t
modesee utl::serialize_t

Reimplemented from utl::Object.

Reimplemented in utl::ObjectSpan< T, D >, and utl::ObjectSpan< Time, Duration >.

Definition at line 366 of file Span.h.

◆ toString()

template<class T , class D >
String utl::Span< T, D >::toString ( ) const
virtual

Return a string representation of self.

Reimplemented from utl::Object.

Reimplemented in utl::ObjectSpan< T, D >, and utl::ObjectSpan< Time, Duration >.

Definition at line 376 of file Span.h.

◆ begin()

template<class T, class D = T>
const T& utl::Span< T, D >::begin ( ) const
inline

◆ setBegin()

template<class T, class D = T>
void utl::Span< T, D >::setBegin ( const T &  begin)
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()

template<class T, class D = T>
const T& utl::Span< T, D >::end ( ) const
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()

template<class T, class D = T>
void utl::Span< T, D >::setEnd ( const T &  end)
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()

template<class T, class D = T>
void utl::Span< T, D >::set ( const T &  begin,
const T &  end 
)
inline

Set the beginning and end of the span.

Definition at line 100 of file Span.h.

◆ isNil()

template<class T, class D = T>
bool utl::Span< T, D >::isNil ( ) const
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()

template<class T, class D = T>
void utl::Span< T, D >::setNil ( )
inline

Set the span to nil.

Definition at line 115 of file Span.h.

◆ isRelaxed()

template<class T, class D = T>
bool utl::Span< T, D >::isRelaxed ( ) const
inline

Get the relaxed flag.

Definition at line 122 of file Span.h.

◆ setRelaxed()

template<class T, class D = T>
void utl::Span< T, D >::setRelaxed ( bool  relaxed)
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()

template<class T, class D = T>
D utl::Span< T, D >::size ( ) const
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()

template<class T, class D>
Span< T, D > & utl::Span< T, D >::clip ( const Span< T, D > &  span)

Clip against the given span.

Definition at line 387 of file Span.h.

◆ clipBegin()

template<class T, class D = T>
Span<T, D>& utl::Span< T, D >::clipBegin ( const T &  t)
inline

Clip the beginning against the given value.

Definition at line 147 of file Span.h.

◆ clipEnd()

template<class T, class D = T>
Span<T, D>& utl::Span< T, D >::clipEnd ( const T &  t)
inline

Clip the end against the given value.

Definition at line 155 of file Span.h.

◆ contains() [1/2]

template<class T, class D = T>
bool utl::Span< T, D >::contains ( const Span< T, D > &  span) const
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]

template<class T, class D = T>
bool utl::Span< T, D >::contains ( const T &  v) const
inline

Determine whether self contains the given value.

Definition at line 170 of file Span.h.

◆ isContainedBy()

template<class T, class D = T>
bool utl::Span< T, D >::isContainedBy ( const Span< T, D > &  span) const
inline

Determine whether self is contained by the given span.

Definition at line 177 of file Span.h.

◆ merge()

template<class T, class D = T>
void utl::Span< T, D >::merge ( const Span< T, D > &  span)
inline

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()

template<class T, class D>
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()

template<class T, class D = T>
bool utl::Span< T, D >::overlaps ( const Span< T, D > &  span) const
inline

Determine whether self overlaps with the given span.

Definition at line 195 of file Span.h.

◆ overlapSize()

template<class T, class D>
D utl::Span< T, D >::overlapSize ( const Span< T, D > &  span) const

Return the length of the overlap with the given span.

Definition at line 411 of file Span.h.

◆ remove()

template<class T, class D>
Span< T, D > utl::Span< T, D >::remove ( const Span< T, D > &  span)

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+()

template<class T, class D = T>
Span<T, D> utl::Span< T, D >::operator+ ( const Span< T, D > &  rhs)
inline

Return self merged with the given span.

Definition at line 210 of file Span.h.

◆ operator+=()

template<class T, class D = T>
const Span<T, D>& utl::Span< T, D >::operator+= ( const Span< T, D > &  rhs)
inline

Merge with the given span.

Definition at line 218 of file Span.h.


The documentation for this class was generated from the following file: