Asposecpplib
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...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 
- Public Types inherited from System::Collections::Generic::ICollection< bool >
typedef bool ValueType
 Value type name. More...
 
typedef ICollection< bool > ThisType
 Collection type name. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< bool >
typedef IEnumerator< bool > IEnumeratorType
 Enumerator type. More...
 
using ValueType = bool
 

Public Member Functions

ASPOSECPP_SHARED_API SharedPtr< Generic::IEnumerator< bool > > GetEnumerator () override
 Creates enumerator object. More...
 
ASPOSECPP_SHARED_API BitArray (const bitset &bits)
 Copy constructor. More...
 
ASPOSECPP_SHARED_API BitArray (const BitArray &bits)
 Copy constructor. More...
 
ASPOSECPP_SHARED_API BitArray (const System::ArrayPtr< bool > &values)
 Copy constructor. More...
 
ASPOSECPP_SHARED_API BitArray (const System::ArrayPtr< uint8_t > &bytes)
 Copy constructor. More...
 
ASPOSECPP_SHARED_API BitArray (const System::ArrayPtr< int > &values)
 Copy constructor. More...
 
ASPOSECPP_SHARED_API BitArray (int length, bool defaultValue=false)
 Fill constructor. More...
 
ASPOSECPP_SHARED_API Reference operator[] (int index)
 Accessor function. More...
 
ASPOSECPP_SHARED_API bool idx_get (int index) const
 Getter function. More...
 
ASPOSECPP_SHARED_API void idx_set (int index, bool value)
 Setter function. More...
 
ASPOSECPP_SHARED_API int get_Length () const
 Gets container size. More...
 
ASPOSECPP_SHARED_API int get_Count () const override
 Gets container size. More...
 
ASPOSECPP_SHARED_API void Add (const bool &item) override
 Adds value to the end of container. More...
 
ASPOSECPP_SHARED_API void Clear () override
 Deletes all elements. More...
 
ASPOSECPP_SHARED_API bool Contains (const bool &item) const override
 Checks whether specific value is present in container. Not implemented. More...
 
ASPOSECPP_SHARED_API bool Remove (const bool &item) override
 Returns first occurance of specified value. Not implemented. More...
 
ASPOSECPP_SHARED_API void CopyTo (System::ArrayPtr< bool > array, int arrayIndex) override
 Copies data to existing array elements. More...
 
ASPOSECPP_SHARED_API BitArray And (const BitArray &value)
 Calculates bitwise 'and' between two BitSets. More...
 
ASPOSECPP_SHARED_API BitArray Or (const BitArray &value)
 Calculates bitwise 'or' between two BitSets. More...
 
ASPOSECPP_SHARED_API BitArray Xor (const BitArray &value)
 Calculates bitwise 'xor' between two BitSets. More...
 
ASPOSECPP_SHARED_API BitArray Not ()
 Negates BitSet. More...
 
ASPOSECPP_SHARED_API bool Get (int index) const
 Gets BitArray element. More...
 
ASPOSECPP_SHARED_API void Set (int index, bool value)
 Sets BitArray element. More...
 
ASPOSECPP_SHARED_API void SetAll (bool value)
 Sets all elements to specific value. More...
 
ASPOSECPP_SHARED_API bitsetdata ()
 Underlying data structure access. More...
 
ASPOSECPP_SHARED_API const bitsetdata () const
 Underlying data structure access. More...
 
ASPOSECPP_SHARED_API bool operator== (const BitArray &other) const
 Bitwise comparison operator. More...
 
ASPOSECPP_SHARED_API bool operator!= (const BitArray &other) const
 Bitwise comparison operator. More...
 
ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument) override
 Formal implementation of weak template arguments mechanism; inapplicable to this class. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API 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 refernce counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. 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 int get_Count () const=0
 Gets number of elements in collection. More...
 
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...
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< bool >
bool LINQ_ElementAt (int index)
 Returns the element at a specified index in a sequence. More...
 
bool LINQ_First ()
 Returns the first element of a sequence. More...
 
bool LINQ_FirstOrDefault ()
 Returns the first element of a sequence, or a default value if the sequence is empty. More...
 
bool LINQ_FirstOrDefault (std::function< bool(bool)> predicate)
 Returns the first element of the sequence that satisfies a condition or a default value if no such element is found. More...
 
bool LINQ_Last ()
 Returns the last element of a sequence. More...
 
bool LINQ_LastOrDefault ()
 Returns the last element of a sequence, or a default value if the sequence is empty. More...
 
SharedPtr< List< bool > > 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...
 
System::ArrayPtr< bool > LINQ_ToArray ()
 Creates an array from a sequence. More...
 
bool LINQ_All (std::function< bool(bool)> 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(bool)> predicate)
 Determines whether any element of a sequence exists or satisfies a condition. More...
 
SharedPtr< IEnumerable< bool > > LINQ_Where (std::function< bool(bool)> predicate)
 Filters a sequence based on the specified predicate. More...
 
bool LINQ_Contains (bool value)
 Determines if a sequence contains a specified value. More...
 
SharedPtr< IEnumerable< ResultType > > LINQ_Cast ()
 Casts the elements to the specified type. More...
 
SharedPtr< IEnumerable< Result > > LINQ_Cast ()
 
SharedPtr< IEnumerable< ResultType > > LINQ_OfType ()
 Filters the elements of the sequence based on the specified type. More...
 
SharedPtr< IEnumerable< Result > > LINQ_OfType ()
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< bool, ResultType > &selector)
 Transforms elements of a sequence. More...
 
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, Result > &selector)
 

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

Member Typedef Documentation

◆ bitset

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

Underlying data type.

Constructor & Destructor Documentation

◆ BitArray() [1/6]

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

Copy constructor.

Parameters
bitsContainer to copy data from.

◆ BitArray() [2/6]

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

Copy constructor.

Parameters
bitsContainer to copy data from.

◆ BitArray() [3/6]

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

Copy constructor.

Parameters
valuesContainer to elementwise copy data from.

◆ BitArray() [4/6]

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

Copy constructor.

Parameters
bytesContainer to bitwise copy data from.

◆ BitArray() [5/6]

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

Copy constructor.

Parameters
valuesContainer to bitwise copy data from.

◆ BitArray() [6/6]

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

Fill constructor.

Parameters
lengthNumber of elements to fill.
defaultValueFilling value.

Member Function Documentation

◆ Add()

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

ASPOSECPP_SHARED_API BitArray System::Collections::BitArray::And ( const BitArray value)

Calculates bitwise 'and' between two BitSets.

Parameters
valueRHS operand.
Returns
Bitwise 'and' result.

◆ Clear()

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

Deletes all elements.

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

◆ Contains()

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

ASPOSECPP_SHARED_API 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]

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

Underlying data structure access.

Returns
Reference to underlying data structure.

◆ data() [2/2]

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

Underlying data structure access.

Returns
Const reference to underlying data structure.

◆ Get()

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

ASPOSECPP_SHARED_API int System::Collections::BitArray::get_Count ( ) const
override

Gets container size.

Returns
Actual number of elements in container.

◆ get_Length()

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

Gets container size.

Returns
Actual number of elements in container.

◆ GetEnumerator()

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

Creates enumerator object.

Returns
Constructed enumerator object.

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

◆ idx_get()

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

Getter function.

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

◆ idx_set()

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

Setter function.

Parameters
indexIndex of bit to set.
valueNew bit value.

◆ Not()

ASPOSECPP_SHARED_API BitArray System::Collections::BitArray::Not ( )

Negates BitSet.

Returns
Negated BitSet.

◆ operator!=()

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

ASPOSECPP_SHARED_API 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[]()

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

Accessor function.

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

◆ Or()

ASPOSECPP_SHARED_API BitArray System::Collections::BitArray::Or ( const BitArray value)

Calculates bitwise 'or' between two BitSets.

Parameters
valueRHS operand.
Returns
Bitwise 'or' result.

◆ Remove()

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

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

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

Sets all elements to specific value.

Parameters
valueFilling value.

◆ SetTemplateWeakPtr()

ASPOSECPP_SHARED_API void System::Collections::BitArray::SetTemplateWeakPtr ( unsigned int  argument)
overridevirtual

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

Reimplemented from System::Object.

◆ Xor()

ASPOSECPP_SHARED_API BitArray System::Collections::BitArray::Xor ( const BitArray value)

Calculates bitwise 'xor' between two BitSets.

Parameters
valueRHS operand.
Returns
Bitwise 'xor' result.