BitArray.Xor Method (BitArray)


Performs the bitwise exclusive OR operation between the elements of the current BitArray object against the corresponding elements in the specified array. The current BitArray object will be modified to store the result of the bitwise exclusive OR operation.

Namespace:   System.Collections
Assembly:  mscorlib (in mscorlib.dll)

Public Function Xor (
	value As BitArray
) As BitArray


Type: System.Collections.BitArray

The array with which to perform the bitwise exclusive OR operation.

Return Value

Type: System.Collections.BitArray

An array containing the result of the bitwise exclusive OR operation, which is a reference to the current BitArray object.

Exception Condition

value is null.


value and the current BitArray do not have the same number of elements.

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

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

The following code example shows how to perform the XOR operation between two BitArray objects.

Imports System
Imports System.Collections
Imports Microsoft.VisualBasic

Public Class SamplesBitArray    

    Public Shared Sub Main()

        ' Creates and initializes two BitArrays of the same size.
        Dim myBA1 As New BitArray(4)
        Dim myBA2 As New BitArray(4)
        myBA1(0) = False
        myBA1(1) = False
        myBA1(2) = True
        myBA1(3) = True
        myBA2(0) = False
        myBA2(2) = False
        myBA2(1) = True
        myBA2(3) = True

        ' Performs a bitwise XOR operation between BitArray instances of the same size.
        Console.WriteLine("Initial values")
        PrintValues(myBA1, 8)
        PrintValues(myBA2, 8)

        PrintValues(myBA1.Xor(myBA2), 8)

        Console.WriteLine("After XOR")
        PrintValues(myBA1, 8)
        PrintValues(myBA2, 8)

        ' Performing XOR between BitArray instances of different sizes returns an exception.
            Dim myBA3 As New BitArray(8)
            myBA3(0) = False
            myBA3(1) = False
            myBA3(2) = False
            myBA3(3) = False
            myBA3(4) = True
            myBA3(5) = True
            myBA3(6) = True
            myBA3(7) = True
        Catch myException As Exception
            Console.WriteLine("Exception: " + myException.ToString())
        End Try
    End Sub

    Public Shared Sub PrintValues(myList As IEnumerable, myWidth As Integer)
        Dim i As Integer = myWidth
        Dim obj As [Object]
        For Each obj In  myList
            If i <= 0 Then
                i = myWidth
            End If
            i -= 1
            Console.Write("{0,8}", obj)
        Next obj
    End Sub 'PrintValues

End Class

' This code produces the following output.
' Initial values
' myBA1:   False   False    True    True
' myBA2:   False    True   False    True
' Result
' XOR:   False    True    True   False
' After XOR
' myBA1:   False    True    True   False
' myBA2:   False    True   False    True
' Exception: System.ArgumentException: Array lengths must be the same.
'    at System.Collections.BitArray.Xor(BitArray value)
'    at SamplesBitArray.Main()

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top