System::Collections::BitArray Class Reference

Array of bits which can be addressed by index. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

Inherits System::Object, and System::Collections::Generic::ICollection< bool >.

Classes

class  Enumerator
 Enumerator type for iteration purposes. More...
 
class  Reference
 Reference class to allow treating BitArray elements in contexts where bool is required. More...
 

Public Types

typedef Detail::BitsetType bitset
 Underlying data type. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Public Types inherited from System::Collections::Generic::ICollection< bool >
typedef bool ValueType
 Value type name. More...
 
typedef ICollection< boolThisType
 Collection type name. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< T >
typedef IEnumerator< T > IEnumeratorType
 Enumerator type. More...
 
using ValueType = T
 
using iterator = EnumeratorBasedIterator< T, IEnumerator< T > >
 
using const_iterator = iterator
 

Public Member Functions

SharedPtr< Generic::IEnumerator< bool > > GetEnumerator () override
 Creates enumerator object. More...
 
 BitArray (const bitset &bits)
 Copy constructor. More...
 
 BitArray (const BitArray &bits)
 Copy constructor. More...
 
 BitArray (BitArrayPtr array)
 Copy constructor. More...
 
 BitArray (const System::ArrayPtr< bool > &values)
 Copy constructor. More...
 
 BitArray (const System::ArrayPtr< uint8_t > &bytes)
 Copy constructor. More...
 
 BitArray (const System::ArrayPtr< int > &values)
 Copy constructor. More...
 
 BitArray (int length, bool defaultValue=false)
 Fill constructor. More...
 
Reference operator[] (int index)
 Accessor function. More...
 
bool idx_get (int index) const
 Getter function. More...
 
void idx_set (int index, bool value)
 Setter function. More...
 
int get_Length () const
 Gets container size. More...
 
int get_Count () const override
 Gets container size. More...
 
void Add (const bool &item) override
 Adds value to the end of container. More...
 
void Clear () override
 Deletes all elements. More...
 
bool Contains (const bool &item) const override
 Checks whether specific value is present in container. Not implemented. More...
 
bool Remove (const bool &item) override
 Returns first occurance of specified value. Not implemented. More...
 
void CopyTo (System::ArrayPtr< bool > array, int arrayIndex) override
 Copies data to existing array elements. More...
 
BitArrayPtr And (BitArrayPtr value)
 Calculates bitwise 'and' between two BitSets. More...
 
BitArrayPtr Or (BitArrayPtr value)
 Calculates bitwise 'or' between two BitSets. More...
 
BitArrayPtr Xor (BitArrayPtr value)
 Calculates bitwise 'xor' between two BitSets. More...
 
BitArrayPtr Not ()
 Negates BitSet. More...
 
bool Get (int index) const
 Gets BitArray element. More...
 
void Set (int index, bool value)
 Sets BitArray element. More...
 
void SetAll (bool value)
 Sets all elements to specific value. More...
 
bitsetdata ()
 Underlying data structure access. More...
 
const bitsetdata () const
 Underlying data structure access. More...
 
bool operator== (const BitArray &other) const
 Bitwise comparison operator. More...
 
bool operator!= (const BitArray &other) const
 Bitwise comparison operator. More...
 
void SetTemplateWeakPtr (uint32_t argument) override
 Formal implementation of weak template arguments mechanism; inapplicable to this class. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 
- Public Member Functions inherited from System::Collections::Generic::ICollection< bool >
virtual bool get_IsReadOnly () const
 Checks if collection is read only. More...
 
ICollectionoperator= (ICollection &&)
 Move assignment operator. More...
 
ICollectionoperator= (const ICollection &)
 Move assignment operator. More...
 
 ICollection ()
 Default constructor. More...
 
 ICollection (const ICollection &)
 Copy constructor. More...
 
 ICollection (ICollection &&)
 Move constructor. More...
 
virtual ~ICollection ()
 Destructor. More...
 
virtual SharedPtr< Objectget_SyncRoot () const
 Gets the object the collection is being synchronized through. More...
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< T >
LINQ_ElementAt (int index)
 Returns the element at a specified index in a sequence. More...
 
LINQ_First ()
 Returns the first element of a sequence. More...
 
LINQ_First (const Func< T, bool > &predicate)
 Returns the first element of a sequence that satisfy the specified condition. More...
 
LINQ_FirstOrDefault ()
 Returns the first element of a sequence, or a default value if the sequence is empty. More...
 
LINQ_FirstOrDefault (std::function< bool(T)> predicate)
 Returns the first element of the sequence that satisfies a condition or a default value if no such element is found. More...
 
LINQ_Last ()
 Returns the last element of a sequence. More...
 
LINQ_LastOrDefault ()
 Returns the last element of a sequence, or a default value if the sequence is empty. More...
 
SharedPtr< List< T > > LINQ_ToList ()
 Creates a List<T> from a sequence. More...
 
int LINQ_Count ()
 Returns the number of elements in the sequence (calculated via direct counting). More...
 
int LINQ_Count (const Func< T, bool > &predicate)
 Returns the number of elements in the sequence that satisfy the specified condition. More...
 
System::ArrayPtr< T > LINQ_ToArray ()
 Creates an array from a sequence. More...
 
bool LINQ_All (std::function< bool(T)> predicate)
 Determines whether all elements of a sequence satisfy a condition. More...
 
bool LINQ_Any ()
 Determines whether a sequence contains any elements. More...
 
bool LINQ_Any (std::function< bool(T)> predicate)
 Determines whether any element of a sequence exists or satisfies a condition. More...
 
SharedPtr< IEnumerable< T > > LINQ_Where (std::function< bool(T)> predicate)
 Filters a sequence based on the specified predicate. More...
 
bool LINQ_Contains (T value)
 Determines if a sequence contains a specified value. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_Cast ()
 Casts the elements to the specified type. More...
 
template<typename Key >
SharedPtr< IEnumerable< T > > LINQ_OrderBy (const Func< T, Key > &keySelector)
 Sorts the elements of a sequence in ascending order according to the key values selected by keySelector. More...
 
template<typename Key >
SharedPtr< IEnumerable< T > > LINQ_OrderByDescending (const Func< T, Key > &keySelector)
 Sorts the elements of a sequence in descending order according to the key values selected by keySelector. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_OfType ()
 Filters the elements of the sequence based on the specified type. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< T, ResultType > &selector)
 Transforms elements of a sequence. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< T, int32_t, ResultType > &selector)
 Transforms each element of a sequence into a new form by incorporating the element's index. More...
 
SharedPtr< IEnumerable< T > > LINQ_Concat (SharedPtr< IEnumerable< T >> sequence)
 Concatenates two sequences. More...
 
template<typename Key >
System::SharedPtr< IEnumerable< System::SharedPtr< System::Linq::IGrouping< Key, T > > > > LINQ_GroupBy (System::Func< T, Key > keyPredicate)
 Groups the elements of a sequence. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_SelectMany (const Func< T, SharedPtr< IEnumerable< ResultType >>> &selector)
 Projects each element of a sequence and combines the resulting sequences into one sequence. More...
 
iterator begin () noexcept
 Gets iterator pointing to the first element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
iterator end () noexcept
 Gets iterator pointing right after the last element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
const_iterator begin () const noexcept
 Gets iterator pointing to the first element (if any) of the const-qualified instance of the collection. More...
 
const_iterator end () const noexcept
 Gets iterator pointing right after the last element (if any) of the const-qualified instance of the collection. More...
 
const_iterator cbegin () const noexcept
 Gets iterator pointing to the first const-qualified element (if any) of the collection. More...
 
const_iterator cend () const noexcept
 Gets iterator pointing right after the last const-qualified element (if any) of the collection. More...
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_Cast ()
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_OfType ()
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, Result > &selector)
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, int32_t, Result > &selector)
 
template<typename Key >
SharedPtr< IEnumerable< Source > > LINQ_OrderBy (const Func< Source, Key > &keySelector)
 
template<typename Key >
SharedPtr< IEnumerable< Source > > LINQ_OrderByDescending (const Func< Source, Key > &keySelector)
 
template<typename Key >
SharedPtr< IEnumerable< SharedPtr< System::Linq::IGrouping< Key, Source > > > > LINQ_GroupBy (System::Func< Source, Key > keyPredicate)
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_SelectMany (const Func< Source, SharedPtr< IEnumerable< Result >>> &selector)
 

Protected Member Functions

 ~BitArray () override
 Destructor. More...
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< T >
 ~IEnumerable () override
 Destructor. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 

Detailed Description

Array of bits which can be addressed by index. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

#include <system/collections/bitarray.h>
#include <system/smart_ptr.h>
using namespace System;
for (const auto item: bitArray) {
std::cout << item << ' ';
}
std::cout << std::endl;
}
int main() {
// Constructs a new instance of the BitArray class.
auto bitArray = MakeObject<System::Collections::BitArray>(3);
// Print values.
Print(bitArray);
return 0;
}
/*
This code example produces the following output:
0 0 0
*/
Interface of object providing enumerator on contained elements.
Definition: ienumerable.h:22
Pointer class to wrap types being allocated on heap. Use it to manage memory for classes inheriting O...
Definition: smart_ptr.h:93
Definition: algorithms.h:10
Definition: TrackedValueType.h:271

Member Typedef Documentation

◆ bitset

typedef Detail::BitsetType System::Collections::BitArray::bitset

Underlying data type.

Constructor & Destructor Documentation

◆ BitArray() [1/7]

System::Collections::BitArray::BitArray ( const bitset bits)

Copy constructor.

Parameters
bitsContainer to copy data from.

◆ BitArray() [2/7]

System::Collections::BitArray::BitArray ( const BitArray bits)

Copy constructor.

Parameters
bitsContainer to copy data from.

◆ BitArray() [3/7]

System::Collections::BitArray::BitArray ( BitArrayPtr  array)

Copy constructor.

Parameters
arrayBitArray to copy data from.

◆ BitArray() [4/7]

System::Collections::BitArray::BitArray ( const System::ArrayPtr< bool > &  values)

Copy constructor.

Parameters
valuesContainer to elementwise copy data from.

◆ BitArray() [5/7]

System::Collections::BitArray::BitArray ( const System::ArrayPtr< uint8_t > &  bytes)

Copy constructor.

Parameters
bytesContainer to bitwise copy data from.

◆ BitArray() [6/7]

System::Collections::BitArray::BitArray ( const System::ArrayPtr< int > &  values)

Copy constructor.

Parameters
valuesContainer to bitwise copy data from.

◆ BitArray() [7/7]

System::Collections::BitArray::BitArray ( int  length,
bool  defaultValue = false 
)

Fill constructor.

Parameters
lengthNumber of elements to fill.
defaultValueFilling value.

◆ ~BitArray()

System::Collections::BitArray::~BitArray ( )
overrideprotected

Destructor.

Member Function Documentation

◆ Add()

void System::Collections::BitArray::Add ( const bool item)
overridevirtual

Adds value to the end of container.

Parameters
itemValue to push.

Implements System::Collections::Generic::ICollection< bool >.

◆ And()

BitArrayPtr System::Collections::BitArray::And ( BitArrayPtr  value)

Calculates bitwise 'and' between two BitSets.

Parameters
valueRHS operand.
Returns
Bitwise 'and' result.

◆ Clear()

void System::Collections::BitArray::Clear ( )
overridevirtual

Deletes all elements.

Implements System::Collections::Generic::ICollection< bool >.

◆ Contains()

bool System::Collections::BitArray::Contains ( const bool item) const
overridevirtual

Checks whether specific value is present in container. Not implemented.

Parameters
itemItem to look for.
Returns
true if the element is present, false otherwise.

Implements System::Collections::Generic::ICollection< bool >.

◆ CopyTo()

void System::Collections::BitArray::CopyTo ( System::ArrayPtr< bool array,
int  arrayIndex 
)
overridevirtual

Copies data to existing array elements.

Parameters
arrayDestination array.
arrayIndexDestination array beginning index.

Implements System::Collections::Generic::ICollection< bool >.

◆ data() [1/2]

bitset& System::Collections::BitArray::data ( )

Underlying data structure access.

Returns
Reference to underlying data structure.

◆ data() [2/2]

const bitset& System::Collections::BitArray::data ( ) const

Underlying data structure access.

Returns
Const reference to underlying data structure.

◆ Get()

bool System::Collections::BitArray::Get ( int  index) const

Gets BitArray element.

Parameters
indexIndex of bit to get.
Returns
Boolean representation of addressed bit.

◆ get_Count()

int System::Collections::BitArray::get_Count ( ) const
overridevirtual

Gets container size.

Returns
Actual number of elements in container.

Implements System::Collections::Generic::ICollection< bool >.

◆ get_Length()

int System::Collections::BitArray::get_Length ( ) const

Gets container size.

Returns
Actual number of elements in container.

◆ GetEnumerator()

SharedPtr<Generic::IEnumerator<bool> > System::Collections::BitArray::GetEnumerator ( )
overridevirtual

Creates enumerator object.

Returns
Constructed enumerator object.

Implements System::Collections::Generic::IEnumerable< T >.

◆ idx_get()

bool System::Collections::BitArray::idx_get ( int  index) const

Getter function.

Parameters
indexIndex of bit to extract.
Returns
Value of referenced bit.

◆ idx_set()

void System::Collections::BitArray::idx_set ( int  index,
bool  value 
)

Setter function.

Parameters
indexIndex of bit to set.
valueNew bit value.

◆ Not()

BitArrayPtr System::Collections::BitArray::Not ( )

Negates BitSet.

Returns
Negated BitSet.

◆ operator!=()

bool System::Collections::BitArray::operator!= ( const BitArray other) const

Bitwise comparison operator.

Parameters
otherRHS operand.
Returns
false if sizes and all bits match, true otherwise.

◆ operator==()

bool System::Collections::BitArray::operator== ( const BitArray other) const

Bitwise comparison operator.

Parameters
otherRHS operand.
Returns
true if sizes and all bits match, false otherwise.

◆ operator[]()

Reference System::Collections::BitArray::operator[] ( int  index)

Accessor function.

Parameters
indexIndex of bit to access.
Returns
Reference allowing operations on referred bit.

◆ Or()

BitArrayPtr System::Collections::BitArray::Or ( BitArrayPtr  value)

Calculates bitwise 'or' between two BitSets.

Parameters
valueRHS operand.
Returns
Bitwise 'or' result.

◆ Remove()

bool System::Collections::BitArray::Remove ( const bool item)
overridevirtual

Returns first occurance of specified value. Not implemented.

Parameters
itemValue to remove.
Returns
true if value is found and removed, false otherwise.

Implements System::Collections::Generic::ICollection< bool >.

◆ Set()

void System::Collections::BitArray::Set ( int  index,
bool  value 
)

Sets BitArray element.

Parameters
indexIndex of bit to set.
valueBoolean representation of value being set.

◆ SetAll()

void System::Collections::BitArray::SetAll ( bool  value)

Sets all elements to specific value.

Parameters
valueFilling value.

◆ SetTemplateWeakPtr()

void System::Collections::BitArray::SetTemplateWeakPtr ( uint32_t  argument)
overridevirtual

Formal implementation of weak template arguments mechanism; inapplicable to this class.

Reimplemented from System::Object.

◆ Xor()

BitArrayPtr System::Collections::BitArray::Xor ( BitArrayPtr  value)

Calculates bitwise 'xor' between two BitSets.

Parameters
valueRHS operand.
Returns
Bitwise 'xor' result.