Interlocked.CompareExchange メソッド

定義

名前空間:

System.Threading

アセンブリ:

netstandard.dll, System.Threading.dll

2 つの値が等しいかどうかを比較し、等しい場合は、最初の値をアトミック演算として置き換えます。

オーバーロード

名前	説明
CompareExchange(UIntPtr, UIntPtr, UIntPtr)	2 つのネイティブ サイズの符号なし整数の等価性を比較し、等しい場合は、最初の整数をアトミック演算として置き換えます。
CompareExchange(UInt64, UInt64, UInt64)	2 つの 64 ビット符号なし整数の等価性を比較し、等しい場合は、最初の値をアトミック演算として置き換えます。
CompareExchange(UInt32, UInt32, UInt32)	2 つの 32 ビット符号なし整数の等価性を比較し、等しい場合は、最初の値をアトミック演算として置き換えます。
CompareExchange(UInt16, UInt16, UInt16)	2 つの 16 ビット符号付き整数の等価性を比較し、等しい場合は、最初の値をアトミック演算として置き換えます。
CompareExchange(Single, Single, Single)	2 つの単精度浮動小数点数の等価性を比較し、等しい場合は、最初の値をアトミック演算として置き換えます。
CompareExchange(Object, Object, Object)	参照の等価性について 2 つのオブジェクトを比較し、等しい場合は、最初のオブジェクトをアトミック操作として置き換えます。
CompareExchange(SByte, SByte, SByte)	2 つの 8 ビット符号付き整数の等価性を比較し、等しい場合は、最初の値をアトミック演算として置き換えます。
CompareExchange(Int64, Int64, Int64)	2 つの 64 ビット符号付き整数の等価性を比較し、等しい場合は、最初の値をアトミック演算として置き換えます。
CompareExchange(Int32, Int32, Int32)	2 つの 32 ビット符号付き整数の等価性を比較し、等しい場合は、最初の値をアトミック演算として置き換えます。
CompareExchange(Int16, Int16, Int16)	2 つの 16 ビット符号なし整数の等価性を比較し、等しい場合は、最初の値をアトミック演算として置き換えます。
CompareExchange(Double, Double, Double)	2 つの倍精度浮動小数点数の等価性を比較し、等しい場合は、最初の値をアトミック演算として置き換えます。
CompareExchange(Byte, Byte, Byte)	2 つの 8 ビット符号なし整数の等価性を比較し、等しい場合は、最初の値をアトミック演算として置き換えます。
CompareExchange(IntPtr, IntPtr, IntPtr)	2 つのネイティブ サイズの符号付き整数の等価性を比較し、等しい場合は、最初の整数をアトミック演算として置き換えます。
CompareExchange<T>(T, T, T)	指定した型 T の 2 つのインスタンスを参照の等価性と比較し、等しい場合は、最初のインスタンスをアトミック操作として置き換えます。

CompareExchange(UIntPtr, UIntPtr, UIntPtr)

ソース:

Interlocked.cs

重要

この API は CLS 準拠ではありません。

2 つのネイティブ サイズの符号なし整数の等価性を比較し、等しい場合は、最初の整数をアトミック演算として置き換えます。

public:
 static UIntPtr CompareExchange(UIntPtr % location1, UIntPtr value, UIntPtr comparand);

[System.CLSCompliant(false)]
public static UIntPtr CompareExchange(ref UIntPtr location1, UIntPtr value, UIntPtr comparand);

[<System.CLSCompliant(false)>]
static member CompareExchange : unativeint * unativeint * unativeint -> unativeint

Public Shared Function CompareExchange (ByRef location1 As UIntPtr, value As UIntPtr, comparand As UIntPtr) As UIntPtr

パラメーター

location1

UIntPtr

unativeint

変換先。値が comparand の値と比較され、場合によっては valueに置き換えられます。

value

UIntPtr

unativeint

比較の結果が等しい場合に、変換先の値を置き換える値。

comparand

UIntPtr

unativeint

location1の値と比較される値。

返品

UIntPtr

unativeint

location1の元の値。

属性

CLSCompliantAttribute

例外

NullReferenceException

location1のアドレスは、null ポインターです。

CompareExchange(UInt64, UInt64, UInt64)

ソース:

Interlocked.cs

重要

この API は CLS 準拠ではありません。

2 つの 64 ビット符号なし整数の等価性を比較し、等しい場合は、最初の値をアトミック演算として置き換えます。

public:
 static System::UInt64 CompareExchange(System::UInt64 % location1, System::UInt64 value, System::UInt64 comparand);

[System.CLSCompliant(false)]
public static ulong CompareExchange(ref ulong location1, ulong value, ulong comparand);

[<System.CLSCompliant(false)>]
static member CompareExchange : uint64 * uint64 * uint64 -> uint64

Public Shared Function CompareExchange (ByRef location1 As ULong, value As ULong, comparand As ULong) As ULong

パラメーター

location1

UInt64

変換先。値が comparand と比較され、置き換えられる可能性があります。

value

UInt64

比較の結果が等しい場合に、変換先の値を置き換える値。

comparand

UInt64

location1の値と比較される値。

返品

UInt64

location1の元の値。

属性

CLSCompliantAttribute

例外

NullReferenceException

location1のアドレスは、null ポインターです。

CompareExchange(UInt32, UInt32, UInt32)

ソース:

Interlocked.cs

重要

この API は CLS 準拠ではありません。

2 つの 32 ビット符号なし整数の等価性を比較し、等しい場合は、最初の値をアトミック演算として置き換えます。

public:
 static System::UInt32 CompareExchange(System::UInt32 % location1, System::UInt32 value, System::UInt32 comparand);

[System.CLSCompliant(false)]
public static uint CompareExchange(ref uint location1, uint value, uint comparand);

[<System.CLSCompliant(false)>]
static member CompareExchange : uint32 * uint32 * uint32 -> uint32

Public Shared Function CompareExchange (ByRef location1 As UInteger, value As UInteger, comparand As UInteger) As UInteger

パラメーター

location1

UInt32

変換先。値が comparand と比較され、置き換えられる可能性があります。

value

UInt32

比較の結果が等しい場合に、変換先の値を置き換える値。

comparand

UInt32

location1の値と比較される値。

返品

UInt32

location1の元の値。

属性

CLSCompliantAttribute

例外

NullReferenceException

location1のアドレスは、null ポインターです。

CompareExchange(UInt16, UInt16, UInt16)

ソース:

Interlocked.cs

重要

この API は CLS 準拠ではありません。

2 つの 16 ビット符号付き整数の等価性を比較し、等しい場合は、最初の値をアトミック演算として置き換えます。

public:
 static System::UInt16 CompareExchange(System::UInt16 % location1, System::UInt16 value, System::UInt16 comparand);

[System.CLSCompliant(false)]
public static ushort CompareExchange(ref ushort location1, ushort value, ushort comparand);

[<System.CLSCompliant(false)>]
static member CompareExchange : uint16 * uint16 * uint16 -> uint16

Public Shared Function CompareExchange (ByRef location1 As UShort, value As UShort, comparand As UShort) As UShort

パラメーター

location1

UInt16

変換先。値が comparand と比較され、置き換えられる可能性があります。

value

UInt16

比較の結果が等しい場合に、変換先の値を置き換える値。

comparand

UInt16

location1の値と比較される値。

返品

UInt16

location1の元の値。

属性

CLSCompliantAttribute

例外

NullReferenceException

location1のアドレスは、null ポインターです。

CompareExchange(Single, Single, Single)

ソース:

Interlocked.cs

2 つの単精度浮動小数点数の等価性を比較し、等しい場合は、最初の値をアトミック演算として置き換えます。

public:
 static float CompareExchange(float % location1, float value, float comparand);

public static float CompareExchange(ref float location1, float value, float comparand);

static member CompareExchange : single * single * single -> single

Public Shared Function CompareExchange (ByRef location1 As Single, value As Single, comparand As Single) As Single

パラメーター

location1

Single

変換先。値が comparand と比較され、置き換えられる可能性があります。

value

Single

比較の結果が等しい場合に、変換先の値を置き換える値。

comparand

Single

location1の値と比較される値。

返品

Single

location1の元の値。

例外

NullReferenceException

location1のアドレスは null ポインターです。

例

次のコード例は、実行中の合計 Single 値を累積するスレッド セーフなメソッドを示しています。 スレッド セーフメソッドと通常の加算を使用して、2 つのスレッドによって一連の Single 値が追加され、スレッドが完了すると合計が比較されます。 デュアル プロセッサ コンピューターでは、合計に大きな違いがあります。

スレッド セーフ メソッドでは、実行中の合計の初期値が保存され、 CompareExchange メソッドを使用して、新しく計算された合計を古い合計と交換します。 戻り値が実行中の合計の保存された値と等しくない場合は、別のスレッドによってその間に合計が更新されます。 その場合は、実行中の合計を更新する試行を繰り返す必要があります。

// This example demonstrates a thread-safe method that adds to a
// running total.  
using System;
using System.Threading;

public class ThreadSafe
{
    // Field totalValue contains a running total that can be updated
    // by multiple threads. It must be protected from unsynchronized 
    // access.
    private float totalValue = 0.0F;

    // The Total property returns the running total.
    public float Total { get { return totalValue; }}

    // AddToTotal safely adds a value to the running total.
    public float AddToTotal(float addend)
    {
        float initialValue, computedValue;
        do
        {
            // Save the current running total in a local variable.
            initialValue = totalValue;

            // Add the new value to the running total.
            computedValue = initialValue + addend;

            // CompareExchange compares totalValue to initialValue. If
            // they are not equal, then another thread has updated the
            // running total since this loop started. CompareExchange
            // does not update totalValue. CompareExchange returns the
            // contents of totalValue, which do not equal initialValue,
            // so the loop executes again.
        }
        while (initialValue != Interlocked.CompareExchange(ref totalValue, 
            computedValue, initialValue));
        // If no other thread updated the running total, then 
        // totalValue and initialValue are equal when CompareExchange
        // compares them, and computedValue is stored in totalValue.
        // CompareExchange returns the value that was in totalValue
        // before the update, which is equal to initialValue, so the 
        // loop ends.

        // The function returns computedValue, not totalValue, because
        // totalValue could be changed by another thread between
        // the time the loop ends and the function returns.
        return computedValue;
    }
}

public class Test
{
    // Create an instance of the ThreadSafe class to test.
    private static ThreadSafe ts = new ThreadSafe();
    private static float control;

    private static Random r = new Random();
    private static ManualResetEvent mre = new ManualResetEvent(false);

    public static void Main()
    {
        // Create two threads, name them, and start them. The
        // thread will block on mre.
        Thread t1 = new Thread(TestThread);
        t1.Name = "Thread 1";
        t1.Start();
        Thread t2 = new Thread(TestThread);
        t2.Name = "Thread 2";
        t2.Start();

        // Now let the threads begin adding random numbers to 
        // the total.
        mre.Set();
        
        // Wait until all the threads are done.
        t1.Join();
        t2.Join();

        Console.WriteLine("Thread safe: {0}  Ordinary float: {1}", 
            ts.Total, control);
    }

    private static void TestThread()
    {
        // Wait until the signal.
        mre.WaitOne();

        for(int i = 1; i <= 1000000; i++)
        {
            // Add to the running total in the ThreadSafe instance, and
            // to an ordinary float.
            //
            float testValue = (float) r.NextDouble();
            control += testValue;
            ts.AddToTotal(testValue);
        }
    }
}

/* On a dual-processor computer, this code example produces output 
   similar to the following:

Thread safe: 17039.57  Ordinary float: 15706.44
 */

' This example demonstrates a thread-safe method that adds to a
' running total.  
Imports System.Threading

Public Class ThreadSafe
    ' Field totalValue contains a running total that can be updated
    ' by multiple threads. It must be protected from unsynchronized 
    ' access.
    Private totalValue As Single = 0.0

    ' The Total property returns the running total.
    Public ReadOnly Property Total As Single
        Get
            Return totalValue
        End Get
    End Property

    ' AddToTotal safely adds a value to the running total.
    Public Function AddToTotal(ByVal addend As Single) As Single
        Dim initialValue, computedValue As Single
        Do
            ' Save the current running total in a local variable.
            initialValue = totalValue

            ' Add the new value to the running total.
            computedValue = initialValue + addend

            ' CompareExchange compares totalValue to initialValue. If
            ' they are not equal, then another thread has updated the
            ' running total since this loop started. CompareExchange
            ' does not update totalValue. CompareExchange returns the
            ' contents of totalValue, which do not equal initialValue,
            ' so the loop executes again.
        Loop While initialValue <> Interlocked.CompareExchange( _
            totalValue, computedValue, initialValue)
        ' If no other thread updated the running total, then 
        ' totalValue and initialValue are equal when CompareExchange
        ' compares them, and computedValue is stored in totalValue.
        ' CompareExchange returns the value that was in totalValue
        ' before the update, which is equal to initialValue, so the 
        ' loop ends.

        ' The function returns computedValue, not totalValue, because
        ' totalValue could be changed by another thread between
        ' the time the loop ends and the function returns.
        Return computedValue
    End Function
End Class

Public Class Test
    ' Create an instance of the ThreadSafe class to test.
    Private Shared ts As New ThreadSafe()
    Private Shared control As Single

    Private Shared r As New Random()
    Private Shared mre As New ManualResetEvent(false)

    <MTAThread> _
    Public Shared Sub Main()
        ' Create two threads, name them, and start them. The
        ' threads will block on mre.
        Dim t1 As New Thread(AddressOf TestThread)
        t1.Name = "Thread 1"
        t1.Start()
        Dim t2 As New Thread(AddressOf TestThread)
        t2.Name = "Thread 2"
        t2.Start()

        ' Now let the threads begin adding random numbers to 
        ' the total.
        mre.Set()
        
        ' Wait until all the threads are done.
        t1.Join()
        t2.Join()

        Console.WriteLine("Thread safe: {0}  Ordinary Single: {1}", ts.Total, control)
    End Sub

    Private Shared Sub TestThread()
        ' Wait until the signal.
        mre.WaitOne()

        For i As Integer = 1 to 1000000
            ' Add to the running total in the ThreadSafe instance, and
            ' to an ordinary Single.
            '
            Dim testValue As Single = r.NextDouble()
            control += testValue
            ts.AddToTotal(testValue)
        Next
    End Sub
End Class

' On a dual-processor computer, this code example produces output 
' similar to the following:
'
'Thread safe: 17039.57  Ordinary Single: 15706.44

注釈

comparandとlocation1の値が等しい場合、valueはlocation1に格納されます。 それ以外の場合、操作は実行されません。 比較操作と交換操作はアトミック操作として実行されます。 CompareExchangeの戻り値は、交換が行われるかどうかにかかわらず、location1の元の値です。

こちらもご覧ください

• マネージド スレッド処理
• 同期プリミティブの概要

CompareExchange(Object, Object, Object)

ソース:

Interlocked.CoreCLR.cs

参照の等価性について 2 つのオブジェクトを比較し、等しい場合は、最初のオブジェクトをアトミック操作として置き換えます。

public:
 static System::Object ^ CompareExchange(System::Object ^ % location1, System::Object ^ value, System::Object ^ comparand);

public static object? CompareExchange(ref object? location1, object? value, object? comparand);

static member CompareExchange : obj * obj * obj -> obj

Public Shared Function CompareExchange (ByRef location1 As Object, value As Object, comparand As Object) As Object

パラメーター

location1

Object

参照と comparand で比較され、置き換えられる可能性がある変換先オブジェクト。

value

Object

参照比較の結果が等しい場合に、変換先オブジェクトを置き換えるオブジェクト。

comparand

Object

location1のオブジェクトへの参照によって比較されるオブジェクト。

返品

Object

location1の元の値。

例外

NullReferenceException

location1のアドレスは、null ポインターです。

注釈

大事な

CompareExchange<T>(T, T, T) メソッドのオーバーロードは、具象参照型に使用できる一般的な代替手段を提供します。

comparandとlocation1内のオブジェクトが参照によって等しい場合、valueはlocation1に格納されます。 それ以外の場合、操作は実行されません。 比較操作と交換操作はアトミック操作として実行されます。 CompareExchangeの戻り値は、交換が行われるかどうかにかかわらず、location1の元の値です。

手記

オブジェクトは、値の等価性ではなく、参照の等価性と比較されます。 その結果、同じ値型の 2 つのボックス化されたインスタンス (たとえば、整数 3) は常に等しくないように見え、操作は実行されません。 値型では、このオーバーロードを使用しないでください。

こちらもご覧ください

• マネージド スレッド処理
• 同期プリミティブの概要

CompareExchange(SByte, SByte, SByte)

ソース:

Interlocked.cs

重要

この API は CLS 準拠ではありません。

2 つの 8 ビット符号付き整数の等価性を比較し、等しい場合は、最初の値をアトミック演算として置き換えます。

public:
 static System::SByte CompareExchange(System::SByte % location1, System::SByte value, System::SByte comparand);

[System.CLSCompliant(false)]
public static sbyte CompareExchange(ref sbyte location1, sbyte value, sbyte comparand);

[<System.CLSCompliant(false)>]
static member CompareExchange : sbyte * sbyte * sbyte -> sbyte

Public Shared Function CompareExchange (ByRef location1 As SByte, value As SByte, comparand As SByte) As SByte

パラメーター

location1

SByte

変換先。値が comparand と比較され、置き換えられる可能性があります。

value

SByte

比較の結果が等しい場合に、変換先の値を置き換える値。

comparand

SByte

location1の値と比較される値。

返品

SByte

location1の元の値。

属性

CLSCompliantAttribute

例外

NullReferenceException

location1のアドレスは、null ポインターです。

CompareExchange(Int64, Int64, Int64)

ソース:

Interlocked.CoreCLR.cs

2 つの 64 ビット符号付き整数の等価性を比較し、等しい場合は、最初の値をアトミック演算として置き換えます。

public:
 static long CompareExchange(long % location1, long value, long comparand);

public static long CompareExchange(ref long location1, long value, long comparand);

static member CompareExchange : int64 * int64 * int64 -> int64

Public Shared Function CompareExchange (ByRef location1 As Long, value As Long, comparand As Long) As Long

パラメーター

location1

Int64

変換先。値が comparand と比較され、置き換えられる可能性があります。

value

Int64

比較の結果が等しい場合に、変換先の値を置き換える値。

comparand

Int64

location1の値と比較される値。

返品

Int64

location1の元の値。

例外

NullReferenceException

location1のアドレスは null ポインターです。

注釈

comparandとlocation1の値が等しい場合、valueはlocation1に格納されます。 それ以外の場合、操作は実行されません。 比較操作と交換操作はアトミック操作として実行されます。 CompareExchangeの戻り値は、交換が行われるかどうかにかかわらず、location1の元の値です。

こちらもご覧ください

• マネージド スレッド処理
• 同期プリミティブの概要

CompareExchange(Int32, Int32, Int32)

ソース:

Interlocked.CoreCLR.cs

2 つの 32 ビット符号付き整数の等価性を比較し、等しい場合は、最初の値をアトミック演算として置き換えます。

public:
 static int CompareExchange(int % location1, int value, int comparand);

public static int CompareExchange(ref int location1, int value, int comparand);

static member CompareExchange : int * int * int -> int

Public Shared Function CompareExchange (ByRef location1 As Integer, value As Integer, comparand As Integer) As Integer

パラメーター

location1

Int32

変換先。値が comparand と比較され、置き換えられる可能性があります。

value

Int32

比較の結果が等しい場合に、変換先の値を置き換える値。

comparand

Int32

location1の値と比較される値。

返品

Int32

location1の元の値。

例外

NullReferenceException

location1のアドレスは null ポインターです。

例

次のコード例は、実行中の合計を累積するスレッド セーフなメソッドを示しています。 実行中の合計の初期値が保存され、 CompareExchange メソッドを使用して、新しく計算された合計が古い合計と交換されます。 戻り値が実行中の合計の保存された値と等しくない場合は、別のスレッドによってその間に合計が更新されます。 その場合は、実行中の合計を更新する試行を繰り返す必要があります。

手記

Add メソッドを使用すると、整数のスレッド セーフな実行合計を累積する便利な方法が提供されます。

// This example demonstrates a thread-safe method that adds to a
// running total.  It cannot be run directly.  You can compile it
// as a library, or add the class to a project.
using System.Threading;

public class ThreadSafe {
    // totalValue contains a running total that can be updated
    // by multiple threads. It must be protected from unsynchronized 
    // access.
    private int totalValue = 0;

    // The Total property returns the running total.
    public int Total {
        get { return totalValue; }
    }

    // AddToTotal safely adds a value to the running total.
    public int AddToTotal(int addend) {
        int initialValue, computedValue;
        do {
            // Save the current running total in a local variable.
            initialValue = totalValue;

            // Add the new value to the running total.
            computedValue = initialValue + addend;

            // CompareExchange compares totalValue to initialValue. If
            // they are not equal, then another thread has updated the
            // running total since this loop started. CompareExchange
            // does not update totalValue. CompareExchange returns the
            // contents of totalValue, which do not equal initialValue,
            // so the loop executes again.
        } while (initialValue != Interlocked.CompareExchange(
            ref totalValue, computedValue, initialValue));
        // If no other thread updated the running total, then 
        // totalValue and initialValue are equal when CompareExchange
        // compares them, and computedValue is stored in totalValue.
        // CompareExchange returns the value that was in totalValue
        // before the update, which is equal to initialValue, so the 
        // loop ends.

        // The function returns computedValue, not totalValue, because
        // totalValue could be changed by another thread between
        // the time the loop ends and the function returns.
        return computedValue;
    }
}

' This example demonstrates a thread-safe method that adds to a
' running total.  It cannot be run directly.  You can compile it
' as a library, or add the class to a project.
Imports System.Threading

Public Class ThreadSafe
    ' Field totalValue contains a running total that can be updated
    ' by multiple threads. It must be protected from unsynchronized 
    ' access.
    Private totalValue As Integer = 0

    ' The Total property returns the running total.
    Public ReadOnly Property Total As Integer
        Get
            Return totalValue
        End Get
    End Property

    ' AddToTotal safely adds a value to the running total.
    Public Function AddToTotal(ByVal addend As Integer) As Integer
        Dim initialValue, computedValue As Integer
        Do
            ' Save the current running total in a local variable.
            initialValue = totalValue

            ' Add the new value to the running total.
            computedValue = initialValue + addend

            ' CompareExchange compares totalValue to initialValue. If
            ' they are not equal, then another thread has updated the
            ' running total since this loop started. CompareExchange
            ' does not update totalValue. CompareExchange returns the
            ' contents of totalValue, which do not equal initialValue,
            ' so the loop executes again.
        Loop While initialValue <> Interlocked.CompareExchange( _
            totalValue, computedValue, initialValue)
        ' If no other thread updated the running total, then 
        ' totalValue and initialValue are equal when CompareExchange
        ' compares them, and computedValue is stored in totalValue.
        ' CompareExchange returns the value that was in totalValue
        ' before the update, which is equal to initialValue, so the 
        ' loop ends.

        ' The function returns computedValue, not totalValue, because
        ' totalValue could be changed by another thread between
        ' the time the loop ends and the function returns.
        Return computedValue
    End Function
End Class

注釈

comparandとlocation1の値が等しい場合、valueはlocation1に格納されます。 それ以外の場合、操作は実行されません。 比較操作と交換操作はアトミック操作として実行されます。 CompareExchangeの戻り値は、交換が行われるかどうかにかかわらず、location1の元の値です。

こちらもご覧ください

• マネージド スレッド処理
• 同期プリミティブの概要

CompareExchange(Int16, Int16, Int16)

ソース:

Interlocked.cs

2 つの 16 ビット符号なし整数の等価性を比較し、等しい場合は、最初の値をアトミック演算として置き換えます。

public:
 static short CompareExchange(short % location1, short value, short comparand);

public static short CompareExchange(ref short location1, short value, short comparand);

static member CompareExchange : int16 * int16 * int16 -> int16

Public Shared Function CompareExchange (ByRef location1 As Short, value As Short, comparand As Short) As Short

パラメーター

location1

Int16

変換先。値が comparand と比較され、置き換えられる可能性があります。

value

Int16

比較の結果が等しい場合に、変換先の値を置き換える値。

comparand

Int16

location1の値と比較される値。

返品

Int16

location1の元の値。

例外

NullReferenceException

location1のアドレスは、null ポインターです。

CompareExchange(Double, Double, Double)

ソース:

Interlocked.cs

2 つの倍精度浮動小数点数の等価性を比較し、等しい場合は、最初の値をアトミック演算として置き換えます。

public:
 static double CompareExchange(double % location1, double value, double comparand);

public static double CompareExchange(ref double location1, double value, double comparand);

static member CompareExchange : double * double * double -> double

Public Shared Function CompareExchange (ByRef location1 As Double, value As Double, comparand As Double) As Double

パラメーター

location1

Double

変換先。値が comparand と比較され、置き換えられる可能性があります。

value

Double

比較の結果が等しい場合に、変換先の値を置き換える値。

comparand

Double

location1の値と比較される値。

返品

Double

location1の元の値。

例外

NullReferenceException

location1のアドレスは null ポインターです。

例

次のコード例は、実行中の合計 Double 値を累積するスレッド セーフなメソッドを示しています。 スレッド セーフメソッドと通常の加算を使用して、2 つのスレッドによって一連の Double 値が追加され、スレッドが完了すると合計が比較されます。 デュアル プロセッサ コンピューターでは、合計に大きな違いがあります。

スレッド セーフ メソッドでは、実行中の合計の初期値が保存され、 CompareExchange メソッドを使用して、新しく計算された合計を古い合計と交換します。 戻り値が実行中の合計の保存された値と等しくない場合は、別のスレッドによってその間に合計が更新されます。 その場合は、実行中の合計を更新する試行を繰り返す必要があります。

// This example demonstrates a thread-safe method that adds to a
// running total.  
using System;
using System.Threading;

public class ThreadSafe
{
    // Field totalValue contains a running total that can be updated
    // by multiple threads. It must be protected from unsynchronized 
    // access.
    private double totalValue = 0.0;

    // The Total property returns the running total.
    public double Total { get { return totalValue; }}

    // AddToTotal safely adds a value to the running total.
    public double AddToTotal(double addend)
    {
        double initialValue, computedValue;
        do
        {
            // Save the current running total in a local variable.
            initialValue = totalValue;

            // Add the new value to the running total.
            computedValue = initialValue + addend;

            // CompareExchange compares totalValue to initialValue. If
            // they are not equal, then another thread has updated the
            // running total since this loop started. CompareExchange
            // does not update totalValue. CompareExchange returns the
            // contents of totalValue, which do not equal initialValue,
            // so the loop executes again.
        }
        while (initialValue != Interlocked.CompareExchange(ref totalValue, 
            computedValue, initialValue));
        // If no other thread updated the running total, then 
        // totalValue and initialValue are equal when CompareExchange
        // compares them, and computedValue is stored in totalValue.
        // CompareExchange returns the value that was in totalValue
        // before the update, which is equal to initialValue, so the 
        // loop ends.

        // The function returns computedValue, not totalValue, because
        // totalValue could be changed by another thread between
        // the time the loop ends and the function returns.
        return computedValue;
    }
}

public class Test
{
    // Create an instance of the ThreadSafe class to test.
    private static ThreadSafe ts = new ThreadSafe();
    private static double control;

    private static Random r = new Random();
    private static ManualResetEvent mre = new ManualResetEvent(false);

    public static void Main()
    {
        // Create two threads, name them, and start them. The
        // thread will block on mre.
        Thread t1 = new Thread(TestThread);
        t1.Name = "Thread 1";
        t1.Start();
        Thread t2 = new Thread(TestThread);
        t2.Name = "Thread 2";
        t2.Start();

        // Now let the threads begin adding random numbers to 
        // the total.
        mre.Set();
        
        // Wait until all the threads are done.
        t1.Join();
        t2.Join();

        Console.WriteLine("Thread safe: {0}  Ordinary Double: {1}", 
            ts.Total, control);
    }

    private static void TestThread()
    {
        // Wait until the signal.
        mre.WaitOne();

        for(int i = 1; i <= 1000000; i++)
        {
            // Add to the running total in the ThreadSafe instance, and
            // to an ordinary double.
            //
            double testValue = r.NextDouble();
            control += testValue;
            ts.AddToTotal(testValue);
        }
    }
}

/* On a dual-processor computer, this code example produces output 
   similar to the following:

Thread safe: 998068.049623744  Ordinary Double: 759775.417190589
 */

' This example demonstrates a thread-safe method that adds to a
' running total.  
Imports System.Threading

Public Class ThreadSafe
    ' Field totalValue contains a running total that can be updated
    ' by multiple threads. It must be protected from unsynchronized 
    ' access.
    Private totalValue As Double = 0.0

    ' The Total property returns the running total.
    Public ReadOnly Property Total As Double
        Get
            Return totalValue
        End Get
    End Property

    ' AddToTotal safely adds a value to the running total.
    Public Function AddToTotal(ByVal addend As Double) As Double
        Dim initialValue, computedValue As Double
        Do
            ' Save the current running total in a local variable.
            initialValue = totalValue

            ' Add the new value to the running total.
            computedValue = initialValue + addend

            ' CompareExchange compares totalValue to initialValue. If
            ' they are not equal, then another thread has updated the
            ' running total since this loop started. CompareExchange
            ' does not update totalValue. CompareExchange returns the
            ' contents of totalValue, which do not equal initialValue,
            ' so the loop executes again.
        Loop While initialValue <> Interlocked.CompareExchange( _
            totalValue, computedValue, initialValue)
        ' If no other thread updated the running total, then 
        ' totalValue and initialValue are equal when CompareExchange
        ' compares them, and computedValue is stored in totalValue.
        ' CompareExchange returns the value that was in totalValue
        ' before the update, which is equal to initialValue, so the 
        ' loop ends.

        ' The function returns computedValue, not totalValue, because
        ' totalValue could be changed by another thread between
        ' the time the loop ends and the function returns.
        Return computedValue
    End Function
End Class

Public Class Test
    ' Create an instance of the ThreadSafe class to test.
    Private Shared ts As New ThreadSafe()
    Private Shared control As Double

    Private Shared r As New Random()
    Private Shared mre As New ManualResetEvent(false)

    <MTAThread> _
    Public Shared Sub Main()
        ' Create two threads, name them, and start them. The
        ' threads will block on mre.
        Dim t1 As New Thread(AddressOf TestThread)
        t1.Name = "Thread 1"
        t1.Start()
        Dim t2 As New Thread(AddressOf TestThread)
        t2.Name = "Thread 2"
        t2.Start()

        ' Now let the threads begin adding random numbers to 
        ' the total.
        mre.Set()
        
        ' Wait until all the threads are done.
        t1.Join()
        t2.Join()

        Console.WriteLine("Thread safe: {0}  Ordinary Double: {1}", ts.Total, control)
    End Sub

    Private Shared Sub TestThread()
        ' Wait until the signal.
        mre.WaitOne()

        For i As Integer = 1 to 1000000
            ' Add to the running total in the ThreadSafe instance, and
            ' to an ordinary double.
            '
            Dim testValue As Double = r.NextDouble
            control += testValue
            ts.AddToTotal(testValue)
        Next
    End Sub
End Class

' On a dual-processor computer, this code example produces output 
' similar to the following:
'
'Thread safe: 998068.049623744  Ordinary Double: 759775.417190589

注釈

comparandとlocation1の値が等しい場合、valueはlocation1に格納されます。 それ以外の場合、操作は実行されません。 比較操作と交換操作はアトミック操作として実行されます。 CompareExchangeの戻り値は、交換が行われるかどうかにかかわらず、location1の元の値です。

こちらもご覧ください

• マネージド スレッド処理
• 同期プリミティブの概要

CompareExchange(Byte, Byte, Byte)

ソース:

Interlocked.cs

2 つの 8 ビット符号なし整数の等価性を比較し、等しい場合は、最初の値をアトミック演算として置き換えます。

public:
 static System::Byte CompareExchange(System::Byte % location1, System::Byte value, System::Byte comparand);

public static byte CompareExchange(ref byte location1, byte value, byte comparand);

static member CompareExchange : byte * byte * byte -> byte

Public Shared Function CompareExchange (ByRef location1 As Byte, value As Byte, comparand As Byte) As Byte

パラメーター

location1

Byte

変換先。値が comparand と比較され、置き換えられる可能性があります。

value

Byte

比較の結果が等しい場合に、変換先の値を置き換える値。

comparand

Byte

location1の値と比較される値。

返品

Byte

location1の元の値。

例外

NullReferenceException

location1のアドレスは、null ポインターです。

CompareExchange(IntPtr, IntPtr, IntPtr)

ソース:

Interlocked.cs

2 つのネイティブ サイズの符号付き整数の等価性を比較し、等しい場合は、最初の整数をアトミック演算として置き換えます。

public:
 static IntPtr CompareExchange(IntPtr % location1, IntPtr value, IntPtr comparand);

public static IntPtr CompareExchange(ref IntPtr location1, IntPtr value, IntPtr comparand);

static member CompareExchange : nativeint * nativeint * nativeint -> nativeint

Public Shared Function CompareExchange (ByRef location1 As IntPtr, value As IntPtr, comparand As IntPtr) As IntPtr

パラメーター

location1

IntPtr

nativeint

変換先。値が comparand の値と比較され、場合によっては valueに置き換えられます。

value

IntPtr

nativeint

比較の結果が等しい場合に、変換先の値を置き換える値。

comparand

IntPtr

nativeint

location1の値と比較される値。

返品

IntPtr

nativeint

location1の元の値。

例外

NullReferenceException

location1のアドレスは null ポインターです。

注釈

comparandとlocation1の値が等しい場合、valueはlocation1に格納されます。 それ以外の場合、操作は実行されません。 比較操作と交換操作はアトミック操作として実行されます。 このメソッドの戻り値は、交換が行われるかどうかにかかわらず、 location1の元の値です。

手記

IntPtr はプラットフォーム固有の型です。

こちらもご覧ください

• マネージド スレッド処理
• 同期プリミティブの概要

CompareExchange<T>(T, T, T)

ソース:

Interlocked.cs

指定した型 T の 2 つのインスタンスを参照の等価性と比較し、等しい場合は、最初のインスタンスをアトミック操作として置き換えます。

public:
generic <typename T>
 static T CompareExchange(T % location1, T value, T comparand);

public static T CompareExchange<T>(ref T location1, T value, T comparand);

static member CompareExchange : 'T * 'T * 'T -> 'T

Public Shared Function CompareExchange(Of T) (ByRef location1 As T, value As T, comparand As T) As T

型パラメーター

T

location1、value、およびcomparandに使用する型。

パラメーター

location1

T

変換先。値が参照によって comparand と比較され、置き換えられる可能性があります。 これは参照パラメーターです (C# では ref、Visual Basic では ByRef)。

value

T

参照による比較の結果が等しい場合に、変換先の値を置き換える値。

comparand

T

location1の値を参照して比較される値。

返品

T

location1の元の値。

例外

NullReferenceException

location1のアドレスは null ポインターです。

NotSupportedException

サポートされていない T が指定されています。 .NET 8 以前のバージョンでは、T は参照型である必要があります。 .NET 9 以降のバージョンでは、T は参照型、プリミティブ型、または列挙型である必要があります。

注釈

comparandとlocation1内の値が参照によって等しい場合、valueはlocation1に格納されます。 それ以外の場合、操作は実行されません。 比較と交換はアトミック操作として実行されます。 このメソッドの戻り値は、交換が行われるかどうかにかかわらず、 location1の元の値です。