dotnet-api-docs/xml/System.Collections/BitArray.xml at main · dotnet/dotnet-api-docs

History

1834 lines (1690 loc) · 106 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

<AssemblyName>System.Collections</AssemblyName>

</AssemblyInfo>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

</TypeForwardingChain>

<Base>

<BaseTypeName>System.Object</BaseTypeName>

</Base>

<InterfaceName>System.Collections.ICollection</InterfaceName>

</Interface>

<InterfaceName>System.Collections.IEnumerable</InterfaceName>

</Interface>

<InterfaceName>System.ICloneable</InterfaceName>

</Interface>

</Interfaces>

<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Serializable]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Runtime.InteropServices.ComVisible(true)]</AttributeName>

</Attribute>

</Attributes>

<Docs>

<summary>Manages a compact array of bit values, which are represented as Booleans, where <see langword="true" /> indicates that the bit is on (1) and <see langword="false" /> indicates the bit is off (0).</summary>

<format type="text/markdown"><![CDATA[

## Remarks

The <xref:System.Collections.BitArray> class is a collection class in which the capacity is always the same as the count. Elements are added to a <xref:System.Collections.BitArray> by increasing the <xref:System.Collections.BitArray.Length%2A> property; elements are deleted by decreasing the <xref:System.Collections.BitArray.Length%2A> property. The size of a <xref:System.Collections.BitArray> is controlled by the client; indexing past the end of the <xref:System.Collections.BitArray> throws an <xref:System.ArgumentException>. The <xref:System.Collections.BitArray> class provides methods that are not found in other collections, including those that allow multiple elements to be modified at once using a filter, such as <xref:System.Collections.BitArray.And%2A>, <xref:System.Collections.BitArray.Or%2A>, <xref:System.Collections.BitArray.Xor%2A> , <xref:System.Collections.BitArray.Not%2A>, and <xref:System.Collections.BitArray.SetAll%2A>.

The <xref:System.Collections.Specialized.BitVector32> class is a structure that provides the same functionality as <xref:System.Collections.BitArray>, but with faster performance. <xref:System.Collections.Specialized.BitVector32> is faster because it is a value type and therefore allocated on the stack, whereas <xref:System.Collections.BitArray> is a reference type and, therefore, allocated on the heap.

<xref:System.Collections.Specialized.BitVector32?displayProperty=nameWithType> can store exactly 32 bits, whereas <xref:System.Collections.BitArray> can store a variable number of bits. <xref:System.Collections.Specialized.BitVector32> stores both bit flags and small integers, thereby making it ideal for data that is not exposed to the user. However, if the number of required bit flags is unknown, is variable, or is greater than 32, use <xref:System.Collections.BitArray> instead.

<xref:System.Collections.BitArray> is in the <xref:System.Collections> namespace; <xref:System.Collections.Specialized.BitVector32> is in the <xref:System.Collections.Specialized> namespace.

Elements in this collection can be accessed using an integer index. Indexes in this collection are zero-based.

## Examples

The following code example shows how to create and initialize a <xref:System.Collections.BitArray> and how to print out its values.

:::code language="csharp" source="~/snippets/csharp/System.Collections/BitArray/Overview/source.cs" id="Snippet1":::

:::code language="vb" source="~/snippets/visualbasic/System.Collections/BitArray/Overview/source.vb" id="Snippet1":::

]]></format>

</remarks>

<threadsafe>Public static (<see langword="Shared" /> in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

This implementation does not provide a synchronized (thread safe) wrapper for a <see cref="T:System.Collections.BitArray" />.

Enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads.</threadsafe>

</Docs>

<AssemblyName>System.Collections</AssemblyName>

</AssemblyInfo>

<Docs>

<summary>Initializes a new instance of the <see cref="T:System.Collections.BitArray" /> class whose capacity and initial values can be specified.</summary>

</Docs>

</MemberGroup>

<MemberSignature Language="F#" Value="new System.Collections.BitArray : bool[] -> System.Collections.BitArray" Usage="new System.Collections.BitArray values" />

<MemberSignature Language="C++ CLI" Value="public:
 BitArray(cli::array <bool> ^ values);" />

<MemberType>Constructor</MemberType>

<AssemblyName>System.Collections</AssemblyName>

</AssemblyInfo>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

</Parameters>

<Docs>

<param name="values">An array of Booleans to copy.</param>

<summary>Initializes a new instance of the <see cref="T:System.Collections.BitArray" /> class that contains bit values copied from the specified array of Booleans.</summary>

<format type="text/markdown"><![CDATA[

## Remarks

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

]]></format>

</remarks>

</Docs>

</Member>

<MemberSignature Language="F#" Value="new System.Collections.BitArray : byte[] -> System.Collections.BitArray" Usage="new System.Collections.BitArray bytes" />

<MemberSignature Language="C++ CLI" Value="public:
 BitArray(cli::array <System::Byte> ^ bytes);" />

<MemberType>Constructor</MemberType>

<AssemblyName>System.Collections</AssemblyName>

</AssemblyInfo>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

</Parameters>

<Docs>

<param name="bytes">An array of bytes containing the values to copy, where each byte represents eight consecutive bits.</param>

<summary>Initializes a new instance of the <see cref="T:System.Collections.BitArray" /> class that contains bit values copied from the specified array of bytes.</summary>

<format type="text/markdown"><![CDATA[

## 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 `bytes`.

]]></format>

</remarks>

<exception cref="T:System.ArgumentException">The length of <paramref name="bytes" /> is greater than <see cref="F:System.Int32.MaxValue">Int32.MaxValue</see>.</exception>

</Docs>

</Member>

<MemberSignature Language="F#" Value="new System.Collections.BitArray : System.Collections.BitArray -> System.Collections.BitArray" Usage="new System.Collections.BitArray bits" />

<MemberType>Constructor</MemberType>

<AssemblyName>System.Collections</AssemblyName>

</AssemblyInfo>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

</Parameters>

<Docs>

<summary>Initializes a new instance of the <see cref="T:System.Collections.BitArray" /> class that contains bit values copied from the specified <see cref="T:System.Collections.BitArray" />.</summary>

<format type="text/markdown"><![CDATA[

## Remarks

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

]]></format>

</remarks>

</Docs>

</Member>

<MemberSignature Language="F#" Value="new System.Collections.BitArray : int -> System.Collections.BitArray" Usage="new System.Collections.BitArray length" />

<MemberType>Constructor</MemberType>

<AssemblyName>System.Collections</AssemblyName>

</AssemblyInfo>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

</Parameters>

<Docs>

<param name="length">The number of bit values in the new <see cref="T:System.Collections.BitArray" />.</param>

<summary>Initializes a new instance of the <see cref="T:System.Collections.BitArray" /> class that can hold the specified number of bit values, which are initially set to <see langword="false" />.</summary>

<format type="text/markdown"><![CDATA[

## Remarks

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

]]></format>

</remarks>

</Docs>

</Member>

<MemberSignature Language="F#" Value="new System.Collections.BitArray : int[] -> System.Collections.BitArray" Usage="new System.Collections.BitArray values" />

<MemberSignature Language="C++ CLI" Value="public:
 BitArray(cli::array <int> ^ values);" />

<MemberType>Constructor</MemberType>

<AssemblyName>System.Collections</AssemblyName>

</AssemblyInfo>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

</Parameters>

<Docs>

<param name="values">An array of integers containing the values to copy, where each integer represents 32 consecutive bits.</param>

<summary>Initializes a new instance of the <see cref="T:System.Collections.BitArray" /> class that contains bit values copied from the specified array of 32-bit integers.</summary>

<format type="text/markdown"><![CDATA[

## 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`.

]]></format>

</remarks>

<exception cref="T:System.ArgumentException">The length of <paramref name="values" /> is greater than <see cref="F:System.Int32.MaxValue">Int32.MaxValue</see></exception>

</Docs>

</Member>

<MemberSignature Language="F#" Value="new System.Collections.BitArray : int * bool -> System.Collections.BitArray" Usage="new System.Collections.BitArray (length, defaultValue)" />

<MemberType>Constructor</MemberType>

<AssemblyName>System.Collections</AssemblyName>

</AssemblyInfo>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

</Parameters>

<Docs>

<param name="length">The number of bit values in the new <see cref="T:System.Collections.BitArray" />.</param>

<param name="defaultValue">The Boolean value to assign to each bit.</param>

<summary>Initializes a new instance of the <see cref="T:System.Collections.BitArray" /> class that can hold the specified number of bit values, which are initially set to the specified value.</summary>

<format type="text/markdown"><![CDATA[

## Remarks

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

]]></format>

</remarks>

</Docs>

</Member>

<MemberSignature Language="F#" Value="member this.And : System.Collections.BitArray -> System.Collections.BitArray" Usage="bitArray.And value" />

<MemberType>Method</MemberType>

<AssemblyName>System.Collections</AssemblyName>

</AssemblyInfo>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Collections.BitArray</ReturnType>

</ReturnValue>

</Parameters>

<Docs>

<param name="value">The array with which to perform the bitwise AND operation.</param>

<summary>Performs the bitwise AND operation between the elements of the current <see cref="T:System.Collections.BitArray" /> object and the corresponding elements in the specified array. The current <see cref="T:System.Collections.BitArray" /> object will be modified to store the result of the bitwise AND operation.</summary>

<returns>An array containing the result of the bitwise AND operation, which is a reference to the current <see cref="T:System.Collections.BitArray" /> object.</returns>

<format type="text/markdown"><![CDATA[

## 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 <xref:System.Collections.BitArray.Count%2A>.

## Examples

The following code example shows how to perform the bitwise AND operation between two <xref:System.Collections.BitArray> objects.

:::code language="csharp" source="~/snippets/csharp/System.Collections/BitArray/And/source.cs" id="Snippet1":::

:::code language="vb" source="~/snippets/visualbasic/System.Collections/BitArray/And/source.vb" id="Snippet1":::

]]></format>

</remarks>

<paramref name="value" /> and the current <see cref="T:System.Collections.BitArray" /> do not have the same number of elements.</exception>

</Docs>

</Member>

<MemberSignature Language="F#" Value="abstract member Clone : unit -> obj
override this.Clone : unit -> obj" Usage="bitArray.Clone " />

<MemberType>Method</MemberType>

<InterfaceMember>M:System.ICloneable.Clone</InterfaceMember>

</Implements>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Collections</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Object</ReturnType>

</ReturnValue>

<Docs>

<summary>Creates a shallow copy of the <see cref="T:System.Collections.BitArray" />.</summary>

<returns>A shallow copy of the <see cref="T:System.Collections.BitArray" />.</returns>

<format type="text/markdown"><![CDATA[

## Remarks

A shallow copy of a collection copies only the elements of the collection, whether they are reference types or value types, but it does not copy the objects that the references refer to. The references in the new collection point to the same objects that the references in the original collection point to.

In contrast, a deep copy of a collection copies the elements and everything directly or indirectly referenced by the elements.

This method is an `O(n)` operation, where `n` is <xref:System.Collections.BitArray.Count%2A>.

]]></format>

</remarks>

</Docs>

</Member>

<MemberSignature Language="F#" Value="abstract member CopyTo : Array * int -> unit
override this.CopyTo : Array * int -> unit" Usage="bitArray.CopyTo (array, index)" />

<MemberType>Method</MemberType>

<InterfaceMember>M:System.Collections.ICollection.CopyTo(System.Array,System.Int32)</InterfaceMember>

</Implements>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Collections</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Void</ReturnType>

</ReturnValue>

</Parameters>

<Docs>

<param name="array">The one-dimensional <see cref="T:System.Array" /> that is the destination of the elements copied from <see cref="T:System.Collections.BitArray" />. The <see cref="T:System.Array" /> must have zero-based indexing.</param>

<param name="index">The zero-based index in <paramref name="array" /> at which copying begins.</param>

<summary>Copies the entire <see cref="T:System.Collections.BitArray" /> to a compatible one-dimensional <see cref="T:System.Array" />, starting at the specified index of the target array.</summary>

<format type="text/markdown"><![CDATA[

## Remarks

The specified array must be of a compatible type. Only `bool`, `int`, and `byte` types of arrays are supported.

This method is an `O(n)` operation, where `n` is <xref:System.Collections.BitArray.Count%2A>.

## Examples

The following code example shows how to copy a <xref:System.Collections.BitArray> into a one-dimensional <xref:System.Array>.

:::code language="csharp" source="~/snippets/csharp/System.Collections/BitArray/CopyTo/source.cs" id="Snippet1":::

:::code language="vb" source="~/snippets/visualbasic/System.Collections/BitArray/CopyTo/source.vb" id="Snippet1":::

]]></format>

</remarks>

<paramref name="array" /> is multidimensional.

-or-

The number of elements in the source <see cref="T:System.Collections.BitArray" /> is greater than the available space from <paramref name="index" /> to the end of the destination <paramref name="array" />.</exception>

<exception cref="T:System.InvalidCastException">The type of the source <see cref="T:System.Collections.BitArray" /> cannot be cast automatically to the type of the destination <paramref name="array" />.</exception>

</Docs>

</Member>

<MemberType>Property</MemberType>

<InterfaceMember>P:System.Collections.ICollection.Count</InterfaceMember>

</Implements>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Collections</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Int32</ReturnType>

</ReturnValue>

<Docs>

<summary>Gets the number of elements contained in the <see cref="T:System.Collections.BitArray" />.</summary>

<value>The number of elements contained in the <see cref="T:System.Collections.BitArray" />.</value>

<format type="text/markdown"><![CDATA[

## Remarks

<xref:System.Collections.BitArray.Length%2A> and <xref:System.Collections.BitArray.Count%2A> return the same value. <xref:System.Collections.BitArray.Length%2A> can be set to a specific value, but <xref:System.Collections.BitArray.Count%2A> is read-only.

Retrieving the value of this property is an `O(1)` operation.

]]></format>

</remarks>

</Docs>

</Member>

<MemberSignature Language="F#" Value="member this.Get : int -> bool" Usage="bitArray.Get index" />

<MemberType>Method</MemberType>

<AssemblyName>System.Collections</AssemblyName>

</AssemblyInfo>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Boolean</ReturnType>

</ReturnValue>

</Parameters>

<Docs>

<param name="index">The zero-based index of the value to get.</param>

<summary>Gets the value of the bit at a specific position in the <see cref="T:System.Collections.BitArray" />.</summary>

<returns>The value of the bit at position <paramref name="index" />.</returns>

<format type="text/markdown"><![CDATA[

## Remarks

This method is an `O(1)` operation.

## Examples

The following code example shows how to set and get specific elements in a <xref:System.Collections.BitArray>.

:::code language="csharp" source="~/snippets/csharp/System.Collections/BitArray/Get/source.cs" id="Snippet1":::

:::code language="vb" source="~/snippets/visualbasic/System.Collections/BitArray/Get/source.vb" id="Snippet1":::

]]></format>

</remarks>

<paramref name="index" /> is less than zero.

-or-

<paramref name="index" /> is greater than or equal to the number of elements in the <see cref="T:System.Collections.BitArray" />.</exception>

</Docs>

</Member>

<MemberSignature Language="F#" Value="abstract member GetEnumerator : unit -> System.Collections.IEnumerator
override this.GetEnumerator : unit -> System.Collections.IEnumerator" Usage="bitArray.GetEnumerator " />

<MemberType>Method</MemberType>

<InterfaceMember>M:System.Collections.IEnumerable.GetEnumerator</InterfaceMember>

</Implements>

<AssemblyName>System.Collections</AssemblyName>

</AssemblyInfo>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Collections.IEnumerator</ReturnType>

</ReturnValue>

<Docs>

<summary>Returns an enumerator that iterates through the <see cref="T:System.Collections.BitArray" />.</summary>

<returns>An <see cref="T:System.Collections.IEnumerator" /> for the entire <see cref="T:System.Collections.BitArray" />.</returns>

<format type="text/markdown"><![CDATA[

## Remarks

The `foreach` statement of the C# language (`for each` in Visual Basic) hides the complexity of the enumerators. Therefore, using `foreach` is recommended, instead of directly manipulating the enumerator.

Enumerators can be used to read the data in the collection, but they cannot be used to modify the underlying collection.

Initially, the enumerator is positioned before the first element in the collection. <xref:System.Collections.IEnumerator.Reset%2A> also brings the enumerator back to this position. At this position, <xref:System.Collections.IEnumerator.Current%2A> is undefined. Therefore, you must call <xref:System.Collections.IEnumerator.MoveNext%2A> to advance the enumerator to the first element of the collection before reading the value of <xref:System.Collections.IEnumerator.Current%2A>.

<xref:System.Collections.IEnumerator.Current%2A> returns the same object until either <xref:System.Collections.IEnumerator.MoveNext%2A> or <xref:System.Collections.IEnumerator.Reset%2A> is called. <xref:System.Collections.IEnumerator.MoveNext%2A> sets <xref:System.Collections.IEnumerator.Current%2A> to the next element.

If <xref:System.Collections.IEnumerator.MoveNext%2A> passes the end of the collection, the enumerator is positioned after the last element in the collection and <xref:System.Collections.IEnumerator.MoveNext%2A> returns `false`. When the enumerator is at this position, subsequent calls to <xref:System.Collections.IEnumerator.MoveNext%2A> also return `false`. If the last call to <xref:System.Collections.IEnumerator.MoveNext%2A> returned `false`, <xref:System.Collections.IEnumerator.Current%2A> is undefined. To set <xref:System.Collections.IEnumerator.Current%2A> to the first element of the collection again, you can call <xref:System.Collections.IEnumerator.Reset%2A> followed by <xref:System.Collections.IEnumerator.MoveNext%2A>.

An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and its behavior is undefined.

The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization.

This method is an `O(1)` operation.

]]></format>

</remarks>

</Docs>

</Member>

<MemberSignature Language="F#" Value="member this.HasAllSet : unit -> bool" Usage="bitArray.HasAllSet " />

<MemberType>Method</MemberType>

<AssemblyName>System.Collections</AssemblyName>

</AssemblyInfo>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Boolean</ReturnType>

</ReturnValue>

<Docs>

<summary>Determines whether all bits in the <see cref="T:System.Collections.BitArray" /> are set to <see langword="true" />.</summary>

<see langword="true" /> if every bit in the <see cref="T:System.Collections.BitArray" /> is set to <see langword="true" />, or if <see cref="T:System.Collections.BitArray" /> is empty; otherwise, <see langword="false" />.</returns>

<remarks>To be added.</remarks>

</Docs>

</Member>

<MemberSignature Language="F#" Value="member this.HasAnySet : unit -> bool" Usage="bitArray.HasAnySet " />

<MemberType>Method</MemberType>

<AssemblyName>System.Collections</AssemblyName>

</AssemblyInfo>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Boolean</ReturnType>

</ReturnValue>

<Docs>

<summary>Determines whether any bit in the <see cref="T:System.Collections.BitArray" /> is set to <see langword="true" />.</summary>

<see langword="true" /> if <see cref="T:System.Collections.BitArray" /> is not empty and at least one of its bit is set to <see langword="true" />; otherwise, <see langword="false" />.</returns>

<remarks>To be added.</remarks>

</Docs>

</Member>

<MemberType>Property</MemberType>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Collections</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Boolean</ReturnType>

</ReturnValue>

<Docs>

<summary>Gets a value indicating whether the <see cref="T:System.Collections.BitArray" /> is read-only.</summary>

<value>This property is always <see langword="false" />.</value>

<format type="text/markdown"><![CDATA[

## Remarks

<xref:System.Collections.BitArray> implements the <xref:System.Collections.BitArray.IsReadOnly%2A> property because it is required by the <xref:System.Collections.IList?displayProperty=nameWithType> interface.

A collection that is read-only does not allow the addition, removal, or modification of elements after the collection is created.

A collection that is read-only is simply a collection with a wrapper that prevents modifying the collection; therefore, if changes are made to the underlying collection, the read-only collection reflects those changes.

This method is an `O(1)` operation.

]]></format>

</remarks>

</Docs>

</Member>

<MemberType>Property</MemberType>

<InterfaceMember>P:System.Collections.ICollection.IsSynchronized</InterfaceMember>

</Implements>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Collections</AssemblyName>

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

BitArray.xml

Latest commit

History

BitArray.xml

File metadata and controls