xtd::collections::bit_array Class Reference

Inheritance diagram for xtd::collections::bit_array:

Definition

Manages a compact array of bit values, which are represented as booleans, where true indicates that the bit is on (1) and false indicates the bit is off (0).

class core_export_ bit_array : public xtd::object, public xtd::iequatable<bit_array>, public xtd::collections::generic::icollection<bool>, public xtd::iclonable;

Header

#include <xtd/collections/bit_array>

Namespace

xtd::collections

Library

xtd.core

Examples

The following code example shows how to create and initialize a xtd::collections::bit_array and how to print out its values.

#include <xtd/xtd>
 
class program {
public:
  static auto main() -> void {
    // Creates and initializes several bit_arrays.
    auto my_ba1 = collections::bit_array(5_z);
    
    auto my_ba2 = collections::bit_array(5_z, false);
    
    auto my_bytes = array {1_u8, 2_u8, 3_u8, 4_u8, 5_u8};
    auto my_ba3 = collections::bit_array(my_bytes);
    
    auto my_bools = array {true, false, true, true, false};
    auto my_ba4 = collections::bit_array(my_bools);
    
    auto my_ints  = array {6, 7, 8, 9, 10};
    auto my_ba5 = collections::bit_array(my_ints);
    
    // Displays the properties and values of the bit_arrays.
    console::write_line("my_ba1");
    console::write_line("   count:    {0}", my_ba1.count());
    console::write_line("   length:   {0}", my_ba1.length());
    console::write_line("   values:");
    print_values(my_ba1, 8);
    
    console::write_line("my_ba2");
    console::write_line("   count:    {0}", my_ba2.count());
    console::write_line("   length:   {0}", my_ba2.length());
    console::write_line("   values:");
    print_values(my_ba2, 8);
    
    console::write_line("my_ba3");
    console::write_line("   count:    {0}", my_ba3.count());
    console::write_line("   length:   {0}", my_ba3.length());
    console::write_line("   values:");
    print_values(my_ba3, 8);
    
    console::write_line("my_ba4");
    console::write_line("   count:    {0}", my_ba4.count());
    console::write_line("   length:   {0}", my_ba4.length());
    console::write_line("   values:");
    print_values(my_ba4, 8);
    
    console::write_line("my_ba5");
    console::write_line("   count:    {0}", my_ba5.count());
    console::write_line("   length:   {0}", my_ba5.length());
    console::write_line("   values:");
    print_values(my_ba5, 8);
  }
    
  template<typename object_t>
  static auto print_values(const ienumerable<object_t>& my_list, int my_width) -> void {
    auto i = my_width;
    for (auto obj : my_list) {
      if (i <= 0)  {
        i = my_width;
        console::write_line();
      }
      i--;
      console::write("{,8}", obj);
    }
    console::write_line();
  }
};
 
startup_(program::main);
 
 
// This code produces the following output :
//
// my_ba1
//    count:    5
//    length:   5
//    values:
//    false   false   false   false   false
// my_ba2
//    count:    5
//    length:   5
//    values:
//    false   false   false   false   false
// my_ba3
//    count:    40
//    length:   40
//    values:
//     true   false   false   false   false   false   false   false
//    false    true   false   false   false   false   false   false
//     true    true   false   false   false   false   false   false
//    false   false    true   false   false   false   false   false
//     true   false    true   false   false   false   false   false
// my_ba4
//    count:    5
//    length:   5
//    values:
//     true   false    true    true   false
// my_ba5
//    count:    160
//    length:   160
//    values:
//    false    true    true   false   false   false   false   false
//    false   false   false   false   false   false   false   false
//    false   false   false   false   false   false   false   false
//    false   false   false   false   false   false   false   false
//     true    true    true   false   false   false   false   false
//    false   false   false   false   false   false   false   false
//    false   false   false   false   false   false   false   false
//    false   false   false   false   false   false   false   false
//    false   false   false    true   false   false   false   false
//    false   false   false   false   false   false   false   false
//    false   false   false   false   false   false   false   false
//    false   false   false   false   false   false   false   false
//     true   false   false    true   false   false   false   false
//    false   false   false   false   false   false   false   false
//    false   false   false   false   false   false   false   false
//    false   false   false   false   false   false   false   false
//    false    true   false    true   false   false   false   false
//    false   false   false   false   false   false   false   false
//    false   false   false   false   false   false   false   false
//    false   false   false   false   false   false   false   false

Public Aliases
using	value_type
	Represents the list value type.
using	base_type
	Represents the list base type.
using	size_type
	Represents the list size type (usually xtd::usize).
using	difference_type
	Represents the list difference type (usually xtd::ptrdiff).
using	reference
	Represents the reference of list value type.
using	const_reference
	Represents the const reference of list value type.
using	pointer
	Represents the pointer of list value type.
using	const_pointer
	Represents the const pointer of list value type.

Public Constructors
	bit_array (xtd::usize length) noexcept
	Initializes a new instance of the xtd::collections::bit_array class that can hold the specified number of bit values, which are initially set to false.
	bit_array (xtd::usize length, bool defaultValue) noexcept
	Initializes a new instance of the xtd::collections::bit_array class that can hold the specified number of bit values, which are initially set to the specified value.
	bit_array (std::initializer_list< bool > il) noexcept
	Initializes a new instance of the xtd::collections::bit_array class that contains bit values copied from the specified initializer list of booleans.
	bit_array (const xtd::array< bool > &values) noexcept
	Initializes a new instance of the xtd::collections::bit_array class that contains bit values copied from the specified array of booleans.
	bit_array (const xtd::array< xtd::byte > &values) noexcept
	Initializes a new instance of the xtd::collections::bit_array class that contains bit values copied from the specified array of bytes.
	bit_array (const xtd::array< int32 > &values) noexcept
	Initializes a new instance of the xtd::collections::bit_array class that contains bit values copied from the specified array of 32-bit integers.
template<xtd::usize length>
	bit_array (const std::bitset< length > &bit_set) noexcept
	Initializes a new instance of the xtd::collections::bit_array class that contains bit values copied from the specified bitset.
	bit_array (const std::vector< bool > &booleans) noexcept
	Initializes a new instance of the xtd::collections::bit_array class that contains bit values copied from the specified std::vector<bool>.

Public Properties
template<xtd::usize length>
auto	bits () const noexcept -> std::bitset< length >
	Returns a std::bitset object containing the Booleans contained in the current xtd::collections::bit_array.
auto	bits () const noexcept -> std::vector< bool >
	Returns a std::vector<bool> object containing the Booleans contained in the current xtd::collections::bit_array.
auto	count () const noexcept -> xtd::usize override
	Gets the number of elements contained in the xtd::collections::bit_array.
auto	length () const noexcept -> xtd::usize
	Gets the number of elements contained in the xtd::collections::bit_array.
auto	length (xtd::usize value) -> void
	Sets the number of elements contained in the xtd::collections::bit_array.

Public Methods
auto	and_ (const bit_array &value) -> const bit_array &
	Performs the bitwise AND operation on the elements in the current xtd::collections::bit_array against the corresponding elements in the specified xtd::collections::bit_array.
xtd::uptr< xtd::object >	clone () const override
	Creates a new object that is a copy of the current instance.
auto	copy_to (xtd::array< bool > &array, xtd::usize index) const -> void override
	Copies the elements of the xtd::collections::bit_array to an xtd::array, starting at a particular xtd::array index.
auto	equals (const bit_array &value) const noexcept -> bool override
	Determines whether this instance of xtd::collections::bit_array and a specified object, which must also be a xtd::collections::bit_array object, have the same value.
auto	equals (const object &obj) const noexcept -> bool override
	Determines whether this instance of xtd::collections::bit_array and a specified object, which must also be a xtd::collections::bit_array object, have the same value.
auto	get (xtd::usize index) const -> bool
	Gets the value of the bit at a specific position in the xtd::collections::bit_array.
auto	get (xtd::usize index) -> bool &
	Gets the value of the bit at a specific position in the xtd::collections::bit_array.
xtd::collections::generic::enumerator< bool >	get_enumerator () const override
	Returns an enumerator that iterates through a collection.
auto	has_all_set () const noexcept -> bool
	Determines whether all bits in the xtd::collections::bit_array are set to true.
auto	has_any_set () const noexcept -> bool
	Determines whether any bit in the xtd::collections::bit_array is set to true.
auto	left_shift (xtd::usize count) noexcept -> bit_array &
	Shifts all the bit values of the current xtd::collections::bit_array to the left on count bits.
auto	not_ () -> const bit_array &
	Inverts all the bit values in the current xtd::collections::bit_array, so that elements set to true are changed to false, and elements set to false are changed to true.
auto	or_ (const bit_array &value) -> const bit_array &
	Performs the bitwise OR operation on the elements in the current xtd::collections::bit_array against the corresponding elements in the specified xtd::collections::bit_array.
auto	right_shift (xtd::usize count) noexcept -> bit_array &
	Shifts all the bit values of the current xtd::collections::bit_array to the right on count bits.
auto	set (xtd::usize index, bool value) -> void
	Sets the value of the bit at a specific position in the xtd::collections::bit_array.
auto	set_all (bool value) -> void
	Sets all bits in the xtd::collections::bit_array to the specified value.
auto	to_string () const noexcept -> xtd::string override
	Returns a xtd::string that represents the current object.
auto	xor_ (const bit_array &value) -> const bit_array &
	Performs the bitwise exclusive OR operation on the elements in the current xtd::collections::bit_array against the corresponding elements in the specified xtd::collections::bit_array.

Public Operators
auto	operator[] (xtd::usize index) const -> const bool &
	Gets the element at the specified index.
auto	operator[] (xtd::usize index) -> bool &
	Gets or Sets the element at the specified index.
auto	operator& (const bit_array &value) const -> bit_array
	Performs the bitwise AND operation on the elements in the current xtd::collections::bit_array against the corresponding elements in the specified xtd::collections::bit_array.
auto	operator&= (const bit_array &value) -> bit_array &
	Performs the bitwise AND operation on the elements in the current xtd::collections::bit_array against the corresponding elements in the specified xtd::collections::bit_array.
auto	operator| (const bit_array &value) const -> bit_array
	Performs the bitwise OR operation on the elements in the current xtd::collections::bit_array against the corresponding elements in the specified xtd::collections::bit_array.
auto	operator|= (const bit_array &value) -> bit_array &
	Performs the bitwise OR operation on the elements in the current xtd::collections::bit_array against the corresponding elements in the specified xtd::collections::bit_array.
auto	operator^ (const bit_array &value) const -> bit_array
	Performs the bitwise exclusive OR operation on the elements in the current xtd::collections::bit_array against the corresponding elements in the specified xtd::collections::bit_array.
auto	operator^= (const bit_array &value) -> bit_array &
	Performs the bitwise exclusive OR operation on the elements in the current xtd::collections::bit_array against the corresponding elements in the specified xtd::collections::bit_array.
auto	operator~ () const -> bit_array
	Inverts all the bit values in the current xtd::collections::bit_array, so that elements set to true are changed to false, and elements set to false are changed to true.
auto	operator>> (xtd::usize count) const noexcept -> bit_array
	The right shift operator shifts all the bit values of the current xtd::collections::bit_array to the right on count bits.
auto	operator>>= (xtd::usize count) noexcept -> bit_array &
	The right shift operator shifts all the bit values of the current xtd::collections::bit_array to the right on count bits.
auto	operator<< (xtd::usize count) const noexcept -> bit_array
	The left shift operator shifts all the bit values of the current xtd::collections::bit_array to the left on count bits.
auto	operator<<= (xtd::usize count) noexcept -> bit_array &
	The left shift operator shifts all the bit values of the current xtd::collections::bit_array to the left on count bits.

Additional Inherited Members
	object ()=default
	Create a new instance of the ultimate base class object.
virtual xtd::usize	get_hash_code () const noexcept
	Serves as a hash function for a particular type.
virtual type_object	get_type () const noexcept
	Gets the type of the current instance.
template<typename object_t>
xtd::unique_ptr_object< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.
virtual bool	equals (const bit_array &) const noexcept=0
	Indicates whether the current object is equal to another object of the same type.
template<typename object_a_t, typename object_b_t>
static bool	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are considered equal.
template<typename object_a_t, typename object_b_t>
static bool	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are the same instance.

Member Typedef Documentation

value_type

using xtd::collections::bit_array::value_type

Represents the list value type.

base_type

using xtd::collections::bit_array::base_type

Represents the list base type.

size_type

using xtd::collections::bit_array::size_type

Represents the list size type (usually xtd::usize).

difference_type

using xtd::collections::bit_array::difference_type

Represents the list difference type (usually xtd::ptrdiff).

reference

using xtd::collections::bit_array::reference

Represents the reference of list value type.

const_reference

using xtd::collections::bit_array::const_reference

Represents the const reference of list value type.

pointer

using xtd::collections::bit_array::pointer

Represents the pointer of list value type.

const_pointer

using xtd::collections::bit_array::const_pointer

Represents the const pointer of list value type.

Constructor & Destructor Documentation

bit_array() [1/8]

xtd::collections::bit_array::bit_array ( xtd::usize length )

explicitnoexcept

Initializes a new instance of the xtd::collections::bit_array class that can hold the specified number of bit values, which are initially set to false.

Parameters

length_

The number of bit values in the new xtd::collections::bit_array.

Exceptions

xtd::argument_out_of_range_exception

length_ is less than 0.

Remarks

This constructor is an O(n) operation, where n is length_.

bit_array() [2/8]

xtd::collections::bit_array::bit_array ( xtd::usize length, bool defaultValue )

noexcept

Initializes a new instance of the xtd::collections::bit_array class that can hold the specified number of bit values, which are initially set to the specified value.

Parameters

length_	The number of bit values in the new xtd::collections::bit_array.
defaultValueThe	bool value to assign to each bit.

Exceptions

xtd::argument_out_of_range_exception

length_ is less than 0.

Remarks

This constructor is an O(n) operation, where n is length_.

bit_array() [3/8]

xtd::collections::bit_array::bit_array ( std::initializer_list< bool > il )

noexcept

Initializes a new instance of the xtd::collections::bit_array class that contains bit values copied from the specified initializer list of booleans.

Parameters

values

An array of booleans to copy.

Remarks

This constructor is an O(n) operation, where n is the number of elements in values.

bit_array() [4/8]

xtd::collections::bit_array::bit_array ( const xtd::array< bool > & values )

noexcept

Initializes a new instance of the xtd::collections::bit_array class that contains bit values copied from the specified array of booleans.

Parameters

values

An initializer list of booleans to copy.

Remarks

This constructor is an O(n) operation, where n is the number of elements in values.

bit_array() [5/8]

xtd::collections::bit_array::bit_array ( const xtd::array< xtd::byte > & values )

noexcept

Initializes a new instance of the xtd::collections::bit_array class that contains bit values copied from the specified array of bytes.

Parameters

values

An array of bytes containing the values to copy, where each byte represents eight consecutive bits.

Remarks

The first byte in the array represents bits 0 through 7, the second byte represents bits 8 through 15, and so on. The Least Significant Bit of each byte represents the lowest index value: " bytes [0] & 1" represents bit 0, " bytes [0] & 2" represents bit 1, " bytes [0] & 4" represents bit 2, and so on.

This constructor is an O(n) operation, where n is the number of elements in values.

bit_array() [6/8]

xtd::collections::bit_array::bit_array ( const xtd::array< int32 > & values )

noexcept

Initializes a new instance of the xtd::collections::bit_array class that contains bit values copied from the specified array of 32-bit integers.

Parameters

values

An array of integers containing the values to copy, where each integer represents 32 consecutive bits.

Remarks

The number in the first values array element represents bits 0 through 31, the second number in the array represents bits 32 through 63, and so on. The Least Significant Bit of each integer represents the lowest index value: " values [0] & 1" represents bit 0, " values [0] & 2" represents bit 1, " values [0] & 4" represents bit 2, and so on.

This constructor is an O(n) operation, where n is the number of elements in values.

bit_array() [7/8]

template<xtd::usize length>

xtd::collections::bit_array::bit_array ( const std::bitset< length > & bit_set )

inlinenoexcept

Initializes a new instance of the xtd::collections::bit_array class that contains bit values copied from the specified bitset.

Parameters

values

A std::bitset object that contains bit values.

Remarks

This constructor is an O(n) operation, where n is the number of elements in values.

bit_array() [8/8]

xtd::collections::bit_array::bit_array ( const std::vector< bool > & booleans )

noexcept

Initializes a new instance of the xtd::collections::bit_array class that contains bit values copied from the specified std::vector<bool>.

Parameters

values

A std::vector<bool> object that contains bit values.

Remarks

This constructor is an O(n) operation, where n is the number of elements in values.

Member Function Documentation

bits() [1/2]

template<xtd::usize length>

auto xtd::collections::bit_array::bits ( ) const -> std::bitset< length >

inlinenodiscardnoexcept

Returns a std::bitset object containing the Booleans contained in the current xtd::collections::bit_array.

Returns

The std::bitset object.

bits() [2/2]

auto xtd::collections::bit_array::bits ( ) const -> std::vector< bool >

inlinenodiscardnoexcept

Returns a std::vector<bool> object containing the Booleans contained in the current xtd::collections::bit_array.

Returns

The std::vector<bool> object.

count()

auto xtd::collections::bit_array::count ( ) const -> xtd::usize

nodiscardoverridenoexcept

Gets the number of elements contained in the xtd::collections::bit_array.

Returns

The number of elements contained in the xtd::collections::bit_array.

Remarks

Retrieving the value of this property is an O(1) operation; setting the property is an O(n) operation, where n is the new capacity.

length() [1/2]

auto xtd::collections::bit_array::length ( ) const -> xtd::usize

nodiscardnoexcept

Gets the number of elements contained in the xtd::collections::bit_array.

Returns

The number of elements contained in the xtd::collections::bit_array.

Remarks

xtd::collections::bit_array::length and xtd::collections::bit_array::count return the same value. xtd::collections::bit_array::length can be set to a specific value.

length() [2/2]

auto xtd::collections::bit_array::length

(

xtd::usize

value

)

-> void

Sets the number of elements contained in the xtd::collections::bit_array.

Parameters

value

The number of elements contained in the xtd::collections::bit_array.

Remarks

xtd::collections::bit_array::length and xtd::collections::bit_array::count return the same value. xtd::collections::bit_array::length can be set to a specific value.

and_()

auto xtd::collections::bit_array::and_

(

const bit_array &

value

)

-> const bit_array &

Performs the bitwise AND operation on the elements in the current xtd::collections::bit_array against the corresponding elements in the specified xtd::collections::bit_array.

Parameters

value

The xtd::collections::bit_array with which to perform the bitwise AND operation.

Returns

The current instance containing the result of the bitwise AND operation on the elements in the current xtd::collections::bit_array against the corresponding elements in the specified xtd::collections::bit_array.

Exceptions

xtd::argument_exception

value and the current xtd::collections::bit_array do not have the same number of elements.

Remarks

The bitwise AND operation returns true if both operands are true, and returns false if one or both operands are false.

This method is an O(n) operation, where n is count.

clone()

xtd::uptr< xtd::object > xtd::collections::bit_array::clone ( ) const

nodiscardoverridevirtual

Creates a new object that is a copy of the current instance.

Returns

A new object that is a copy of this instance.

Implements xtd::iclonable.

copy_to()

auto xtd::collections::bit_array::copy_to ( xtd::array< bool > & array, xtd::usize index ) const -> void

override

Copies the elements of the xtd::collections::bit_array to an xtd::array, starting at a particular xtd::array index.

Parameters

array	The one-dimensional xtd::array that is the destination of the elements copied from xtd::collections::bit_array. The xtd::array must have zero-based indexing.
index	The zero-based index in array at which copying begins;

Returns

Number of elements copied.

equals() [1/2]

auto xtd::collections::bit_array::equals ( const bit_array & value ) const -> bool

nodiscardoverridenoexcept

Determines whether this instance of xtd::collections::bit_array and a specified object, which must also be a xtd::collections::bit_array object, have the same value.

Parameters

value

The xtd::collections::bit_array to compare with the current object.

Returns

true if the specified value is equal to the current object. otherwise, false.

equals() [2/2]

auto xtd::collections::bit_array::equals ( const object & obj ) const -> bool

nodiscardoverridevirtualnoexcept

Determines whether this instance of xtd::collections::bit_array and a specified object, which must also be a xtd::collections::bit_array object, have the same value.

Parameters

obj	The object to compare with the current object.

Returns

true if the specified object is equal to the current object. otherwise, false.

Reimplemented from xtd::object.

get() [1/2]

auto xtd::collections::bit_array::get ( xtd::usize index ) const -> bool

nodiscard

Gets the value of the bit at a specific position in the xtd::collections::bit_array.

Parameters

index

The zero-based index of the value to get.

Returns

The value of the bit at position index.

Exceptions

xtd::argument_out_of_range_exception

index is less than zero. -or- index is greater than or equal to the number of elements in the xtd::collections::bit_array.

Remarks

This method is an O(1) operation.

get() [2/2]

auto xtd::collections::bit_array::get ( xtd::usize index ) -> bool &

nodiscard

Gets the value of the bit at a specific position in the xtd::collections::bit_array.

Parameters

index

The zero-based index of the value to get.

Returns

The value of the bit at position index.

Exceptions

xtd::argument_out_of_range_exception

index is less than zero. -or- index is greater than or equal to the number of elements in the xtd::collections::bit_array.

Remarks

This method is an O(1) operation.

get_enumerator()

xtd::collections::generic::enumerator< bool > xtd::collections::bit_array::get_enumerator ( ) const

nodiscardoverride

Returns an enumerator that iterates through a collection.

Returns

An xtd::collections::generic::ienumerator object that can be used to iterate through the collection.

has_all_set()

auto xtd::collections::bit_array::has_all_set ( ) const -> bool

nodiscardnoexcept

Determines whether all bits in the xtd::collections::bit_array are set to true.

Returns

true if every bit in the xtd::collections::bit_array is set to true, or if xtd::collections::bit_array is empty; otherwise, false.

has_any_set()

auto xtd::collections::bit_array::has_any_set ( ) const -> bool

nodiscardnoexcept

Determines whether any bit in the xtd::collections::bit_array is set to true.

Returns

true if xtd::collections::bit_array is not empty and at least one of its bit is set to true; otherwise, false.

left_shift()

auto xtd::collections::bit_array::left_shift ( xtd::usize count ) -> bit_array &

noexcept

Shifts all the bit values of the current xtd::collections::bit_array to the left on count bits.

Parameters

count

The number of shifts to make for each bit.

Returns

The current xtd::collections::bit_array.

Remarks

The current xtd::collections::bit_array is updated and returned.

not_()

auto xtd::collections::bit_array::not_

(

)

-> const bit_array &

Inverts all the bit values in the current xtd::collections::bit_array, so that elements set to true are changed to false, and elements set to false are changed to true.

Returns

The current instance with inverted bit values.

Remarks

This method is an O(n) operation, where n is count.

or_()

auto xtd::collections::bit_array::or_

(

const bit_array &

value

)

-> const bit_array &

Performs the bitwise OR operation on the elements in the current xtd::collections::bit_array against the corresponding elements in the specified xtd::collections::bit_array.

Parameters

value

The xtd::collections::bit_array with which to perform the bitwise OR operation.

Returns

The current instance containing the result of the bitwise OR operation on the elements in the current xtd::collections::bit_array against the corresponding elements in the specified xtd::collections::bit_array.

Exceptions

xtd::argument_exception

value and the current xtd::collections::bit_array do not have the same number of elements.

Remarks

The bitwise OR operation returns true if one or both operands are true, and returns false if both operands are false.

This method is an O(n) operation, where n is count.

right_shift()

auto xtd::collections::bit_array::right_shift ( xtd::usize count ) -> bit_array &

noexcept

Shifts all the bit values of the current xtd::collections::bit_array to the right on count bits.

Parameters

count

The number of shifts to make for each bit.

Returns

The current xtd::collections::bit_array.

Remarks

The current xtd::collections::bit_array is updated and returned.

set()

auto xtd::collections::bit_array::set	(	xtd::usize	index,
		bool	value ) -> void

Sets the value of the bit at a specific position in the xtd::collections::bit_array.

Parameters

index	The zero-based index of the value to get.
value	The bool value to assign to the bit.

Exceptions

xtd::argument_out_of_range_exception

index is less than zero. -or- index is greater than or equal to the number of elements in the xtd::collections::bit_array.

Remarks

This method is an O(1) operation.

set_all()

auto xtd::collections::bit_array::set_all

(

bool

value

)

-> void

Sets all bits in the xtd::collections::bit_array to the specified value.

Parameters

value

The bool value to assign to all bits.

Remarks

This method is an O(n) operation, where n is count.

to_string()

auto xtd::collections::bit_array::to_string ( ) const -> xtd::string

nodiscardoverridevirtualnoexcept

Returns a xtd::string that represents the current object.

Returns

A string that represents the current object.

Reimplemented from xtd::object.

xor_()

auto xtd::collections::bit_array::xor_

(

const bit_array &

value

)

-> const bit_array &

Performs the bitwise exclusive OR operation on the elements in the current xtd::collections::bit_array against the corresponding elements in the specified xtd::collections::bit_array.

Parameters

value

The xtd::collections::bit_array with which to perform the bitwise exclusive OR operation.

Returns

The current instance containing the result of the bitwise exclusive OR operation on the elements in the current xtd::collections::bit_array against the corresponding elements in the specified xtd::collections::bit_array.

Exceptions

xtd::argument_exception

value and the current xtd::collections::bit_array do not have the same number of elements.

Remarks

The bitwise exclusive OR operation returns true if exactly one operand is true, and returns false if both operands have the same bool value.

This method is an O(n) operation, where n is count.

operator[]() [1/2]

auto xtd::collections::bit_array::operator[]

(

xtd::usize

index

)

const -> const bool &

Gets the element at the specified index.

Parameters

index

The zero-based index of the element to get.

Returns

The element at the specified index.

Exceptions

xtd::argument_out_of_range_exception

index is less than 0 or index is equal to or greater than count.

operator[]() [2/2]

auto xtd::collections::bit_array::operator[]

(

xtd::usize

index

)

-> bool &

Gets or Sets the element at the specified index.

Parameters

index

The zero-based index of the element to get.

Returns

The element at the specified index.

Exceptions

xtd::argument_out_of_range_exception

index is less than 0 or index is equal to or greater than count.

operator&()

auto xtd::collections::bit_array::operator&

(

const bit_array &

value

)

const -> bit_array

Performs the bitwise AND operation on the elements in the current xtd::collections::bit_array against the corresponding elements in the specified xtd::collections::bit_array.

Parameters

value

The xtd::collections::bit_array with which to perform the bitwise AND operation.

Returns

The new instance containing the result of the bitwise AND operation on the elements in the current xtd::collections::bit_array against the corresponding elements in the specified xtd::collections::bit_array.

Exceptions

xtd::argument_exception

value and the current xtd::collections::bit_array do not have the same number of elements.

Remarks

The bitwise AND operation returns true if both operands are true, and returns false if one or both operands are false.

This method is an O(n) operation, where n is count.

operator&=()

auto xtd::collections::bit_array::operator&=

(

const bit_array &

value

)

-> bit_array &

Performs the bitwise AND operation on the elements in the current xtd::collections::bit_array against the corresponding elements in the specified xtd::collections::bit_array.

Parameters

value

The xtd::collections::bit_array with which to perform the bitwise AND operation.

Returns

The current instance containing the result of the bitwise AND operation on the elements in the current xtd::collections::bit_array against the corresponding elements in the specified xtd::collections::bit_array.

Exceptions

xtd::argument_exception

value and the current xtd::collections::bit_array do not have the same number of elements.

Remarks

The bitwise AND operation returns true if both operands are true, and returns false if one or both operands are false.

This method is an O(n) operation, where n is count.

operator|()

auto xtd::collections::bit_array::operator|

(

const bit_array &

value

)

const -> bit_array

Performs the bitwise OR operation on the elements in the current xtd::collections::bit_array against the corresponding elements in the specified xtd::collections::bit_array.

Parameters

value

The xtd::collections::bit_array with which to perform the bitwise OR operation.

Returns

The new instance containing the result of the bitwise OR operation on the elements in the current xtd::collections::bit_array against the corresponding elements in the specified xtd::collections::bit_array.

Exceptions

xtd::argument_exception

value and the current xtd::collections::bit_array do not have the same number of elements.

Remarks

The bitwise OR operation returns true if one or both operands are true, and returns false if both operands are false.

This method is an O(n) operation, where n is count.

operator|=()

auto xtd::collections::bit_array::operator|=

(

const bit_array &

value

)

-> bit_array &

Performs the bitwise OR operation on the elements in the current xtd::collections::bit_array against the corresponding elements in the specified xtd::collections::bit_array.

Parameters

value

The xtd::collections::bit_array with which to perform the bitwise OR operation.

Returns

The current instance containing the result of the bitwise OR operation on the elements in the current xtd::collections::bit_array against the corresponding elements in the specified xtd::collections::bit_array.

Exceptions

xtd::argument_exception

value and the current xtd::collections::bit_array do not have the same number of elements.

Remarks

The bitwise OR operation returns true if one or both operands are true, and returns false if both operands are false.

This method is an O(n) operation, where n is count.

operator^()

auto xtd::collections::bit_array::operator^

(

const bit_array &

value

)

const -> bit_array

Performs the bitwise exclusive OR operation on the elements in the current xtd::collections::bit_array against the corresponding elements in the specified xtd::collections::bit_array.

Parameters

value

The xtd::collections::bit_array with which to perform the bitwise exclusive OR operation.

Returns

The new instance containing the result of the bitwise exclusive OR operation on the elements in the current xtd::collections::bit_array against the corresponding elements in the specified xtd::collections::bit_array.

Exceptions

xtd::argument_exception

value and the current xtd::collections::bit_array do not have the same number of elements.

Remarks

The bitwise exclusive OR operation returns true if exactly one operand is true, and returns false if both operands have the same bool value.

This method is an O(n) operation, where n is count.

operator^=()

auto xtd::collections::bit_array::operator^=

(

const bit_array &

value

)

-> bit_array &

Performs the bitwise exclusive OR operation on the elements in the current xtd::collections::bit_array against the corresponding elements in the specified xtd::collections::bit_array.

Parameters

value

The xtd::collections::bit_array with which to perform the bitwise exclusive OR operation.

Returns

The current instance containing the result of the bitwise exclusive OR operation on the elements in the current xtd::collections::bit_array against the corresponding elements in the specified xtd::collections::bit_array.

Exceptions

xtd::argument_exception

value and the current xtd::collections::bit_array do not have the same number of elements.

Remarks

The bitwise exclusive OR operation returns true if exactly one operand is true, and returns false if both operands have the same bool value.

This method is an O(n) operation, where n is count.

operator~()

auto xtd::collections::bit_array::operator~

(

)

const -> bit_array

Inverts all the bit values in the current xtd::collections::bit_array, so that elements set to true are changed to false, and elements set to false are changed to true.

Returns

The new instance with inverted bit values.

Remarks

This method is an O(n) operation, where n is count.

operator>>()

auto xtd::collections::bit_array::operator>> ( xtd::usize count ) const -> bit_array

noexcept

The right shift operator shifts all the bit values of the current xtd::collections::bit_array to the right on count bits.

Parameters

count

The number of shifts to make for each bit.

Returns

The new shifted xtd::collections::bit_array.

Remarks

The current xtd::collections::bit_array is not updated.

operator>>=()

auto xtd::collections::bit_array::operator>>= ( xtd::usize count ) -> bit_array &

noexcept

The right shift operator shifts all the bit values of the current xtd::collections::bit_array to the right on count bits.

Parameters

count

The number of shifts to make for each bit.

Returns

The current xtd::collections::bit_array.

Remarks

The current xtd::collections::bit_array is updated and returned.

operator<<()

auto xtd::collections::bit_array::operator<< ( xtd::usize count ) const -> bit_array

noexcept

The left shift operator shifts all the bit values of the current xtd::collections::bit_array to the left on count bits.

Parameters

count

The number of shifts to make for each bit.

Returns

The new shifted xtd::collections::bit_array.

Remarks

The current xtd::collections::bit_array is not updated.

operator<<=()

auto xtd::collections::bit_array::operator<<= ( xtd::usize count ) -> bit_array &

noexcept

The left shift operator shifts all the bit values of the current xtd::collections::bit_array to the left on count bits.

Parameters

count

The number of shifts to make for each bit.

Returns

The current xtd::collections::bit_array.

Remarks

The current xtd::collections::bit_array is updated and returned.

---

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

• xtd.core/include/xtd/collections/bit_array.hpp