极速阅览

arrayfire-python/arrayfire.array.html at gh-pages · arrayfire/arrayfire-python · GitHub

Blame

History

Code
Blame

849 lines (763 loc) · 60.5 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

<!DOCTYPE html>

<html>

<head>

<title>arrayfire.array module — ArrayFire Python documentation</title>

</head><body>

<h1>arrayfire.array module<a class="headerlink" href="#module-arrayfire.array" title="Permalink to this headline">¶</a></h1>

Array class and helper functions.

class <code class="sig-prename descclassname">arrayfire.array.</code><code class="sig-name descname">Array</code>(src=None, dims=None, dtype=None, is_device=False, offset=None, strides=None)<a class="reference internal" href="_modules/arrayfire/array.html#Array">[source]</a><a class="headerlink" href="#arrayfire.array.Array" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference internal" href="arrayfire.base.html#arrayfire.base.BaseArray" title="arrayfire.base.BaseArray"><code class="xref py py-class docutils literal notranslate">arrayfire.base.BaseArray</code></a>

A multi dimensional array container.

<dt class="field-odd">Parameters</dt>

<dt>srcoptional: array.array, list or C buffer. default: None.</dt><dd><ul class="simple">

<li>When <cite>src</cite> is <cite>array.array</cite> or <cite>list</cite>, the data is copied to create the Array()</li>

<li>When <cite>src</cite> is None, an empty buffer is created.</li>

</ul>

</dd>

<dt>dimsoptional: tuple of ints. default: (0,)</dt><dd><ul class="simple">

<li>When using the default values of <cite>dims</cite>, the dims are caclulated as <cite>len(src)</cite></li>

</ul>

</dd>

<dt>dtype: optional: str or arrayfire.Dtype. default: None.</dt><dd><ul class="simple">

<dt>if str, must be one of the following:</dt><dd><ul>

<li>‘f’ for float</li>

<li>‘d’ for double</li>

<li>‘B’ for unsigned char</li>

<li>‘h’ for signed 16 bit integer</li>

<li>‘H’ for unsigned 16 bit integer</li>

<li>‘i’ for signed 32 bit integer</li>

<li>‘I’ for unsigned 32 bit integer</li>

<li>‘l’ for signed 64 bit integer</li>

<li>‘L’ for unsigned 64 bit integer</li>

<li>‘F’ for 32 bit complex number</li>

<li>‘D’ for 64 bit complex number</li>

</ul>

</dd>

</dl>

</li>

<dt>if arrayfire.Dtype, must be one of the following:</dt><dd><ul>

<li>Dtype.f32 for float</li>

<li>Dtype.f64 for double</li>

<li>Dtype.b8 for bool</li>

<li>Dtype.u8 for unsigned char</li>

<li>Dtype.s16 for signed 16 bit integer</li>

<li>Dtype.u16 for unsigned 16 bit integer</li>

<li>Dtype.s32 for signed 32 bit integer</li>

<li>Dtype.u32 for unsigned 32 bit integer</li>

<li>Dtype.s64 for signed 64 bit integer</li>

<li>Dtype.u64 for unsigned 64 bit integer</li>

<li>Dtype.c32 for 32 bit complex number</li>

<li>Dtype.c64 for 64 bit complex number</li>

</ul>

</dd>

</dl>

</li>

</ul>

<li>if None, Dtype.f32 is assumed</li>

</ul>

</div></blockquote>

</dd>

</dl>

</dd>

</dl>

Examples

Creating an af.Array() from array.array()

<div class="doctest highlight-default notranslate"><div class="highlight"><pre>>>> import arrayfire as af

>>> import array

>>> a = array.array('f', (1, 2, 3, 4))

>>> af.display(b)

[2 2 1 1]

1.0000 3.0000

2.0000 4.0000

</pre></div>

</div>

Creating an af.Array() from a list

>>> import array

>>> a = [1, 2, 3, 4]

>>> af.display(b)

[4 1 1 1]

1.0000

2.0000

3.0000

4.0000

</pre></div>

</div>

Creating an af.Array() from numpy.array()

<div class="doctest highlight-default notranslate"><div class="highlight"><pre>>>> import numpy as np

>>> import arrayfire as af

>>> a = np.random.random((2,2))

>>> a

array([[ 0.33042524, 0.36135449],

[ 0.86748649, 0.42199135]])

>>> b = af.Array(a.ctypes.data, a.shape, a.dtype.char)

>>> af.display(b)

[2 2 1 1]

0.3304 0.8675

0.3614 0.4220

</pre></div>

</div>

<dt class="field-odd">Attributes</dt>

<dt>arr: ctypes.c_void_p</dt><dd>ctypes variable containing af_array from arrayfire library.

</dd>

</dl>

</dd>

</dl>

Methods

</colgroup>

<tbody>

<tr class="row-odd"><td><a class="reference internal" href="#arrayfire.array.Array.allocated" title="arrayfire.array.Array.allocated"><code class="xref py py-obj docutils literal notranslate">allocated</code></a>()</td>

<td>Returns the number of bytes allocated by the memory manager for the array.</td>

</tr>

<td>Cast current array to a specified data type</td>

</tr>

<td>Performs a deep copy of the array.</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="#arrayfire.array.Array.device_ptr" title="arrayfire.array.Array.device_ptr"><code class="xref py py-obj docutils literal notranslate">device_ptr</code></a>()</td>

<td>Return the device pointer exclusively held by the array.</td>

</tr>

<td>Return the shape of the array as a tuple.</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="#arrayfire.array.Array.dtype" title="arrayfire.array.Array.dtype"><code class="xref py py-obj docutils literal notranslate">dtype</code></a>()</td>

<td>Return the data type as a arrayfire.Dtype enum value.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="#arrayfire.array.Array.elements" title="arrayfire.array.Array.elements"><code class="xref py py-obj docutils literal notranslate">elements</code></a>()</td>

<td>Return the number of elements in the array.</td>

</tr>

<td>Check if the array is of type b8.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="#arrayfire.array.Array.is_column" title="arrayfire.array.Array.is_column"><code class="xref py py-obj docutils literal notranslate">is_column</code></a>()</td>

<td>Check if the array is a column i.e. it has a shape of (rows, 1).</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="#arrayfire.array.Array.is_complex" title="arrayfire.array.Array.is_complex"><code class="xref py py-obj docutils literal notranslate">is_complex</code></a>()</td>

<td>Check if the array is of complex type.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="#arrayfire.array.Array.is_double" title="arrayfire.array.Array.is_double"><code class="xref py py-obj docutils literal notranslate">is_double</code></a>()</td>

<td>Check if the array is of double precision floating point type.</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="#arrayfire.array.Array.is_empty" title="arrayfire.array.Array.is_empty"><code class="xref py py-obj docutils literal notranslate">is_empty</code></a>()</td>

<td>Check if the array is empty i.e. it has no elements.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="#arrayfire.array.Array.is_floating" title="arrayfire.array.Array.is_floating"><code class="xref py py-obj docutils literal notranslate">is_floating</code></a>()</td>

<td>Check if the array is of floating point type.</td>

</tr>

<td>Check if the array is of half floating point type (fp16).</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="#arrayfire.array.Array.is_integer" title="arrayfire.array.Array.is_integer"><code class="xref py py-obj docutils literal notranslate">is_integer</code></a>()</td>

<td>Check if the array is of integer type.</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="#arrayfire.array.Array.is_linear" title="arrayfire.array.Array.is_linear"><code class="xref py py-obj docutils literal notranslate">is_linear</code></a>()</td>

<td>Check if all elements of the array are contiguous.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="#arrayfire.array.Array.is_owner" title="arrayfire.array.Array.is_owner"><code class="xref py py-obj docutils literal notranslate">is_owner</code></a>()</td>

<td>Check if the array owns the raw pointer or is a derived array.</td>

</tr>

<td>Check if the array is not of complex type.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="#arrayfire.array.Array.is_real_floating" title="arrayfire.array.Array.is_real_floating"><code class="xref py py-obj docutils literal notranslate">is_real_floating</code></a>()</td>

<td>Check if the array is real and of floating point type.</td>

</tr>

<td>Check if the array is a row i.e. it has a shape of (1, cols).</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="#arrayfire.array.Array.is_scalar" title="arrayfire.array.Array.is_scalar"><code class="xref py py-obj docutils literal notranslate">is_scalar</code></a>()</td>

<td>Check if the array is scalar i.e. it has only one element.</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="#arrayfire.array.Array.is_single" title="arrayfire.array.Array.is_single"><code class="xref py py-obj docutils literal notranslate">is_single</code></a>()</td>

<td>Check if the array is of single precision floating point type.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="#arrayfire.array.Array.is_sparse" title="arrayfire.array.Array.is_sparse"><code class="xref py py-obj docutils literal notranslate">is_sparse</code></a>()</td>

<td>Check if the array is a sparse matrix.</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="#arrayfire.array.Array.is_vector" title="arrayfire.array.Array.is_vector"><code class="xref py py-obj docutils literal notranslate">is_vector</code></a>()</td>

<td>Check if the array is a vector i.e. it has a shape of one of the following: - (rows, 1) - (1, cols) - (1, 1, vols) - (1, 1, 1, batch).</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="#arrayfire.array.Array.logical_and" title="arrayfire.array.Array.logical_and"><code class="xref py py-obj docutils literal notranslate">logical_and</code></a>(other)</td>

<td>Return self && other.</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="#arrayfire.array.Array.logical_not" title="arrayfire.array.Array.logical_not"><code class="xref py py-obj docutils literal notranslate">logical_not</code></a>()</td>

<td>Return ~self</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="#arrayfire.array.Array.logical_or" title="arrayfire.array.Array.logical_or"><code class="xref py py-obj docutils literal notranslate">logical_or</code></a>(other)</td>

<td>Return self || other.</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="#arrayfire.array.Array.numdims" title="arrayfire.array.Array.numdims"><code class="xref py py-obj docutils literal notranslate">numdims</code></a>()</td>

<td>Return the number of dimensions of the array.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="#arrayfire.array.Array.offset" title="arrayfire.array.Array.offset"><code class="xref py py-obj docutils literal notranslate">offset</code></a>()</td>

<td>Return the offset, of the first element relative to the raw pointer.</td>

</tr>

<td>Return the device pointer held by the array.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="#arrayfire.array.Array.scalar" title="arrayfire.array.Array.scalar"><code class="xref py py-obj docutils literal notranslate">scalar</code></a>()</td>

<td>Return the first element of the array</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="#arrayfire.array.Array.strides" title="arrayfire.array.Array.strides"><code class="xref py py-obj docutils literal notranslate">strides</code></a>()</td>

<td>Return the distance in bytes between consecutive elements for each dimension.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="#arrayfire.array.Array.to_array" title="arrayfire.array.Array.to_array"><code class="xref py py-obj docutils literal notranslate">to_array</code></a>([row_major, return_shape])</td>

<td>Return the data as array.array</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="#arrayfire.array.Array.to_ctype" title="arrayfire.array.Array.to_ctype"><code class="xref py py-obj docutils literal notranslate">to_ctype</code></a>([row_major, return_shape])</td>

<td>Return the data as a ctype C array after copying to host memory</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="#arrayfire.array.Array.to_list" title="arrayfire.array.Array.to_list"><code class="xref py py-obj docutils literal notranslate">to_list</code></a>([row_major])</td>

<td>Return the data as list</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="#arrayfire.array.Array.to_ndarray" title="arrayfire.array.Array.to_ndarray"><code class="xref py py-obj docutils literal notranslate">to_ndarray</code></a>([output])</td>

<dt class="field-odd">Parameters</dt>

</dl>

</td>

</tr>

<td>Return the data type as an int.</td>

</tr>

</tbody>

</table>

property <code class="sig-name descname">H</code><a class="headerlink" href="#arrayfire.array.Array.H" title="Permalink to this definition">¶</a></dt>

<dd>Return the hermitian transpose of the array

</dd></dl>

property <code class="sig-name descname">T</code><a class="headerlink" href="#arrayfire.array.Array.T" title="Permalink to this definition">¶</a></dt>

<dd>Return the transpose of the array

</dd></dl>

<code class="sig-name descname">allocated</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.allocated">[source]</a><a class="headerlink" href="#arrayfire.array.Array.allocated" title="Permalink to this definition">¶</a></dt>

<dd>Returns the number of bytes allocated by the memory manager for the array.

</dd></dl>

<code class="sig-name descname">as_type</code>(ty)<a class="reference internal" href="_modules/arrayfire/array.html#Array.as_type">[source]</a><a class="headerlink" href="#arrayfire.array.Array.as_type" title="Permalink to this definition">¶</a></dt>

<dd>Cast current array to a specified data type

<dt class="field-odd">Parameters</dt>

<dt>tyReturn data type</dt><dd></dd>

</dl>

</dd>

</dl>

</dd></dl>

<code class="sig-name descname">copy</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.copy">[source]</a><a class="headerlink" href="#arrayfire.array.Array.copy" title="Permalink to this definition">¶</a></dt>

<dd>Performs a deep copy of the array.

<dt class="field-odd">Returns</dt>

<dt>out: af.Array()</dt><dd>An identical copy of self.

</dd>

</dl>

</dd>

</dl>

</dd></dl>

<code class="sig-name descname">device_ptr</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.device_ptr">[source]</a><a class="headerlink" href="#arrayfire.array.Array.device_ptr" title="Permalink to this definition">¶</a></dt>

<dd>Return the device pointer exclusively held by the array.

<dt class="field-odd">Returns</dt>

<dt>ptrint</dt><dd>Contains location of the device pointer

</dd>

</dl>

</dd>

</dl>

</dd></dl>

<code class="sig-name descname">dims</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.dims">[source]</a><a class="headerlink" href="#arrayfire.array.Array.dims" title="Permalink to this definition">¶</a></dt>

<dd>Return the shape of the array as a tuple.

</dd></dl>

<code class="sig-name descname">dtype</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.dtype">[source]</a><a class="headerlink" href="#arrayfire.array.Array.dtype" title="Permalink to this definition">¶</a></dt>

<dd>Return the data type as a arrayfire.Dtype enum value.

</dd></dl>

<code class="sig-name descname">elements</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.elements">[source]</a><a class="headerlink" href="#arrayfire.array.Array.elements" title="Permalink to this definition">¶</a></dt>

<dd>Return the number of elements in the array.

</dd></dl>

<code class="sig-name descname">is_bool</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.is_bool">[source]</a><a class="headerlink" href="#arrayfire.array.Array.is_bool" title="Permalink to this definition">¶</a></dt>

<dd>Check if the array is of type b8.

</dd></dl>

<code class="sig-name descname">is_column</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.is_column">[source]</a><a class="headerlink" href="#arrayfire.array.Array.is_column" title="Permalink to this definition">¶</a></dt>

<dd>Check if the array is a column i.e. it has a shape of (rows, 1).

</dd></dl>

<code class="sig-name descname">is_complex</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.is_complex">[source]</a><a class="headerlink" href="#arrayfire.array.Array.is_complex" title="Permalink to this definition">¶</a></dt>

<dd>Check if the array is of complex type.

</dd></dl>

<code class="sig-name descname">is_double</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.is_double">[source]</a><a class="headerlink" href="#arrayfire.array.Array.is_double" title="Permalink to this definition">¶</a></dt>

<dd>Check if the array is of double precision floating point type.

</dd></dl>

<code class="sig-name descname">is_empty</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.is_empty">[source]</a><a class="headerlink" href="#arrayfire.array.Array.is_empty" title="Permalink to this definition">¶</a></dt>

<dd>Check if the array is empty i.e. it has no elements.

</dd></dl>

<code class="sig-name descname">is_floating</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.is_floating">[source]</a><a class="headerlink" href="#arrayfire.array.Array.is_floating" title="Permalink to this definition">¶</a></dt>

<dd>Check if the array is of floating point type.

</dd></dl>

<code class="sig-name descname">is_half</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.is_half">[source]</a><a class="headerlink" href="#arrayfire.array.Array.is_half" title="Permalink to this definition">¶</a></dt>

<dd>Check if the array is of half floating point type (fp16).

</dd></dl>

<code class="sig-name descname">is_integer</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.is_integer">[source]</a><a class="headerlink" href="#arrayfire.array.Array.is_integer" title="Permalink to this definition">¶</a></dt>

<dd>Check if the array is of integer type.

</dd></dl>

<code class="sig-name descname">is_linear</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.is_linear">[source]</a><a class="headerlink" href="#arrayfire.array.Array.is_linear" title="Permalink to this definition">¶</a></dt>

<dd>Check if all elements of the array are contiguous.

</dd></dl>

<code class="sig-name descname">is_owner</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.is_owner">[source]</a><a class="headerlink" href="#arrayfire.array.Array.is_owner" title="Permalink to this definition">¶</a></dt>

<dd>Check if the array owns the raw pointer or is a derived array.

</dd></dl>

<code class="sig-name descname">is_real</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.is_real">[source]</a><a class="headerlink" href="#arrayfire.array.Array.is_real" title="Permalink to this definition">¶</a></dt>

<dd>Check if the array is not of complex type.

</dd></dl>

<code class="sig-name descname">is_real_floating</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.is_real_floating">[source]</a><a class="headerlink" href="#arrayfire.array.Array.is_real_floating" title="Permalink to this definition">¶</a></dt>

<dd>Check if the array is real and of floating point type.

</dd></dl>

<code class="sig-name descname">is_row</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.is_row">[source]</a><a class="headerlink" href="#arrayfire.array.Array.is_row" title="Permalink to this definition">¶</a></dt>

<dd>Check if the array is a row i.e. it has a shape of (1, cols).

</dd></dl>

<code class="sig-name descname">is_scalar</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.is_scalar">[source]</a><a class="headerlink" href="#arrayfire.array.Array.is_scalar" title="Permalink to this definition">¶</a></dt>

<dd>Check if the array is scalar i.e. it has only one element.

</dd></dl>

<code class="sig-name descname">is_single</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.is_single">[source]</a><a class="headerlink" href="#arrayfire.array.Array.is_single" title="Permalink to this definition">¶</a></dt>

<dd>Check if the array is of single precision floating point type.

</dd></dl>

<code class="sig-name descname">is_sparse</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.is_sparse">[source]</a><a class="headerlink" href="#arrayfire.array.Array.is_sparse" title="Permalink to this definition">¶</a></dt>

<dd>Check if the array is a sparse matrix.

</dd></dl>

<code class="sig-name descname">is_vector</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.is_vector">[source]</a><a class="headerlink" href="#arrayfire.array.Array.is_vector" title="Permalink to this definition">¶</a></dt>

<dd>Check if the array is a vector i.e. it has a shape of one of the following:

- (rows, 1)

- (1, cols)

- (1, 1, vols)

- (1, 1, 1, batch)

</dd></dl>

<code class="sig-name descname">logical_and</code>(other)<a class="reference internal" href="_modules/arrayfire/array.html#Array.logical_and">[source]</a><a class="headerlink" href="#arrayfire.array.Array.logical_and" title="Permalink to this definition">¶</a></dt>

<dd>Return self && other.

</dd></dl>

<code class="sig-name descname">logical_not</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.logical_not">[source]</a><a class="headerlink" href="#arrayfire.array.Array.logical_not" title="Permalink to this definition">¶</a></dt>

<dd>Return ~self

</dd></dl>

<code class="sig-name descname">logical_or</code>(other)<a class="reference internal" href="_modules/arrayfire/array.html#Array.logical_or">[source]</a><a class="headerlink" href="#arrayfire.array.Array.logical_or" title="Permalink to this definition">¶</a></dt>

<dd>Return self || other.

</dd></dl>

<code class="sig-name descname">numdims</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.numdims">[source]</a><a class="headerlink" href="#arrayfire.array.Array.numdims" title="Permalink to this definition">¶</a></dt>

<dd>Return the number of dimensions of the array.

</dd></dl>

<code class="sig-name descname">offset</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.offset">[source]</a><a class="headerlink" href="#arrayfire.array.Array.offset" title="Permalink to this definition">¶</a></dt>

<dd>Return the offset, of the first element relative to the raw pointer.

<dt class="field-odd">Returns</dt>

<dt>offsetint</dt><dd>The offset in number of elements

</dd>

</dl>

</dd>

</dl>

</dd></dl>

<code class="sig-name descname">raw_ptr</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.raw_ptr">[source]</a><a class="headerlink" href="#arrayfire.array.Array.raw_ptr" title="Permalink to this definition">¶</a></dt>

<dd>Return the device pointer held by the array.

<dt class="field-odd">Returns</dt>

<dt>ptrint</dt><dd>Contains location of the device pointer

</dd>

</dl>

</dd>

</dl>

</dd></dl>

<code class="sig-name descname">scalar</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.scalar">[source]</a><a class="headerlink" href="#arrayfire.array.Array.scalar" title="Permalink to this definition">¶</a></dt>

<dd>Return the first element of the array

</dd></dl>

property <code class="sig-name descname">shape</code><a class="headerlink" href="#arrayfire.array.Array.shape" title="Permalink to this definition">¶</a></dt>

<dd>The shape of the array

</dd></dl>

<code class="sig-name descname">strides</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.strides">[source]</a><a class="headerlink" href="#arrayfire.array.Array.strides" title="Permalink to this definition">¶</a></dt>

<dd>Return the distance in bytes between consecutive elements for each dimension.

<dt class="field-odd">Returns</dt>

<dt>stridestuple</dt><dd>The strides for each dimension

</dd>

</dl>

</dd>

</dl>

</dd></dl>

<code class="sig-name descname">to_array</code>(row_major=False, return_shape=False)<a class="reference internal" href="_modules/arrayfire/array.html#Array.to_array">[source]</a><a class="headerlink" href="#arrayfire.array.Array.to_array" title="Permalink to this definition">¶</a></dt>

<dd>Return the data as array.array

<dt class="field-odd">Parameters</dt>

<dt>row_major: optional: bool. default: False.</dt><dd>Specifies if a transpose needs to occur before copying to host memory.

</dd>

<dt>return_shape: optional: bool. default: False.</dt><dd>Specifies if the shape of the array needs to be returned.

</dd>

</dl>

</dd>

<dt class="field-even">Returns</dt>

<dt>If return_shape is False:</dt><dd>res: array.array of the appropriate type and length.

</dd>

<dt>else :</dt><dd>(res, dims): array.array and the shape of the array

</dd>

</dl>

</dd>

</dl>

</dd></dl>

<code class="sig-name descname">to_ctype</code>(row_major=False, return_shape=False)<a class="reference internal" href="_modules/arrayfire/array.html#Array.to_ctype">[source]</a><a class="headerlink" href="#arrayfire.array.Array.to_ctype" title="Permalink to this definition">¶</a></dt>

<dd>Return the data as a ctype C array after copying to host memory

<dt class="field-odd">Parameters</dt>

<dt>row_major: optional: bool. default: False.</dt><dd>Specifies if a transpose needs to occur before copying to host memory.

</dd>

<dt>return_shape: optional: bool. default: False.</dt><dd>Specifies if the shape of the array needs to be returned.

</dd>

</dl>

</dd>

<dt class="field-even">Returns</dt>

<dt>If return_shape is False:</dt><dd>res: The ctypes array of the appropriate type and length.

</dd>

<dt>else :</dt><dd>(res, dims): tuple of the ctypes array and the shape of the array

</dd>

</dl>

</dd>

</dl>

</dd></dl>

<code class="sig-name descname">to_list</code>(row_major=False)<a class="reference internal" href="_modules/arrayfire/array.html#Array.to_list">[source]</a><a class="headerlink" href="#arrayfire.array.Array.to_list" title="Permalink to this definition">¶</a></dt>

<dd>Return the data as list

<dt class="field-odd">Parameters</dt>

<dt>row_major: optional: bool. default: False.</dt><dd>Specifies if a transpose needs to occur before copying to host memory.

</dd>

<dt>return_shape: optional: bool. default: False.</dt><dd>Specifies if the shape of the array needs to be returned.

</dd>

</dl>

</dd>

<dt class="field-even">Returns</dt>

<dt>If return_shape is False:</dt><dd>res: list of the appropriate type and length.

</dd>

<dt>else :</dt><dd>(res, dims): list and the shape of the array

</dd>

</dl>

</dd>

</dl>

</dd></dl>

<code class="sig-name descname">to_ndarray</code>(output=None)<a class="reference internal" href="_modules/arrayfire/array.html#Array.to_ndarray">[source]</a><a class="headerlink" href="#arrayfire.array.Array.to_ndarray" title="Permalink to this definition">¶</a></dt>

<dt class="field-odd">Parameters</dt>

<dt>output: optional: numpy. default: None</dt><dd></dd>

</dl>

</dd>

<dt class="field-even">Returns</dt>

<dt>If output is None: Constructs a numpy.array from arrayfire.Array</dt><dd></dd>

<dt>If output is not None: copies content of af.array into numpy array.</dt><dd></dd>

</dl>

</dd>

</dl>

</dd></dl>

<code class="sig-name descname">type</code>()<a class="reference internal" href="_modules/arrayfire/array.html#Array.type">[source]</a><a class="headerlink" href="#arrayfire.array.Array.type" title="Permalink to this definition">¶</a></dt>

<dd>Return the data type as an int.

</dd></dl>

<code class="sig-prename descclassname">arrayfire.array.</code><code class="sig-name descname">constant_array</code>(val, d0, d1=None, d2=None, d3=None, dtype=<Dtype.f32: 0>)<a class="reference internal" href="_modules/arrayfire/array.html#constant_array">[source]</a><a class="headerlink" href="#arrayfire.array.constant_array" title="Permalink to this definition">¶</a></dt>

<dd>Internal function to create a C array. Should not be used externall.

</dd></dl>

<code class="sig-prename descclassname">arrayfire.array.</code><code class="sig-name descname">display</code>(a, precision=4)<a class="reference internal" href="_modules/arrayfire/array.html#display">[source]</a><a class="headerlink" href="#arrayfire.array.display" title="Permalink to this definition">¶</a></dt>

<dd>Displays the contents of an array.

<dt class="field-odd">Parameters</dt>

<dt>aaf.Array</dt><dd>Multi dimensional arrayfire array

</dd>

<dt>precision: int. optional.</dt><dd>Specifies the number of precision bits to display

</dd>

</dl>

</dd>

</dl>

</dd></dl>

<code class="sig-prename descclassname">arrayfire.array.</code><code class="sig-name descname">get_display_dims_limit</code>()<a class="reference internal" href="_modules/arrayfire/array.html#get_display_dims_limit">[source]</a><a class="headerlink" href="#arrayfire.array.get_display_dims_limit" title="Permalink to this definition">¶</a></dt>

<dd>Gets the dimension limit after which array’s data won’t get

presented to the result of str(arr).

Default is None, which means there is no limit.

<dt class="field-odd">Returns</dt>

<dt>tuple of the current limit</dt><dd><ul>

<li>None is there is no limit</li>

</ul>

</dd>

</dl>

</li>

</ul>

</dd>

</dl>

</dd></dl>

<code class="sig-prename descclassname">arrayfire.array.</code><code class="sig-name descname">read_array</code>(filename, index=None, key=None)<a class="reference internal" href="_modules/arrayfire/array.html#read_array">[source]</a><a class="headerlink" href="#arrayfire.array.read_array" title="Permalink to this definition">¶</a></dt>

<dd>Read an array from disk.

<dt class="field-odd">Parameters</dt>

<dt>filenamestr</dt><dd>Location of the data file.

</dd>

<dt>indexint. Optional. Default: None.</dt><dd><ul class="simple">

<li>The index of the array stored in the file.</li>

</ul>

</dd>

<dt>keystr. Optional. Default: None.</dt><dd><ul class="simple">

<li>A name / key associated with the array</li>

<li>If None, index is used.</li>

</ul>

</dd>

</dl>

</dd>

</dl>

</dd></dl>

<code class="sig-prename descclassname">arrayfire.array.</code><code class="sig-name descname">save_array</code>(key, a, filename, append=False)<a class="reference internal" href="_modules/arrayfire/array.html#save_array">[source]</a><a class="headerlink" href="#arrayfire.array.save_array" title="Permalink to this definition">¶</a></dt>

<dd>Save an array to disk.

<dt class="field-odd">Parameters</dt>

<dt>keystr</dt><dd>A name / key associated with the array

</dd>

<dt>aaf.Array</dt><dd>The array to be stored to disk

</dd>

<dt>filenamestr</dt><dd>Location of the data file.

</dd>

<dt>appendBoolean. optional. default: False.</dt><dd>If the file already exists, specifies if the data should be appended or overwritten.

</dd>

</dl>

</dd>

<dt class="field-even">Returns</dt>

<dt>indexint</dt><dd>The index of the array stored in the file.

</dd>

</dl>

</dd>

</dl>

</dd></dl>

<code class="sig-prename descclassname">arrayfire.array.</code><code class="sig-name descname">set_display_dims_limit</code>(*dims)<a class="reference internal" href="_modules/arrayfire/array.html#set_display_dims_limit">[source]</a><a class="headerlink" href="#arrayfire.array.set_display_dims_limit" title="Permalink to this definition">¶</a></dt>

<dd>Sets the dimension limit after which array’s data won’t get

presented to the result of str(arr).

Default is None, which means there is no limit.

<dt class="field-odd">Parameters</dt>

<dt>*dimsdimension limit args</dt><dd></dd>

</dl>

</dd>

</dl>

</dd></dl>

<code class="sig-prename descclassname">arrayfire.array.</code><code class="sig-name descname">transpose</code>(a, conj=False)<a class="reference internal" href="_modules/arrayfire/array.html#transpose">[source]</a><a class="headerlink" href="#arrayfire.array.transpose" title="Permalink to this definition">¶</a></dt>

<dd>Perform the transpose on an input.

<dt class="field-odd">Parameters</dt>

<dt>aaf.Array</dt><dd>Multi dimensional arrayfire array.

</dd>

<dt>conjoptional: bool. default: False.</dt><dd>Flag to specify if a complex conjugate needs to applied for complex inputs.

</dd>

</dl>

</dd>

<dt class="field-even">Returns</dt>

<dt>outaf.Array</dt><dd>Containing the tranpose of <cite>a</cite> for all batches.

</dd>

</dl>

</dd>

</dl>

</dd></dl>

<code class="sig-prename descclassname">arrayfire.array.</code><code class="sig-name descname">transpose_inplace</code>(a, conj=False)<a class="reference internal" href="_modules/arrayfire/array.html#transpose_inplace">[source]</a><a class="headerlink" href="#arrayfire.array.transpose_inplace" title="Permalink to this definition">¶</a></dt>

<dd>Perform inplace transpose on an input.

<dt class="field-odd">Parameters</dt>

<dt>aaf.Array</dt><dd><ul class="simple">

<li>Multi dimensional arrayfire array.</li>

<li>Contains transposed values on exit.</li>

</ul>

</dd>

<dt>conjoptional: bool. default: False.</dt><dd>Flag to specify if a complex conjugate needs to applied for complex inputs.

</dd>

</dl>

</dd>

</dl>

</dd></dl>

</div>

</a>

<h1 class="logo"><a href="index.html">ArrayFire</a></h1>

<h3>Navigation</h3>

<h3>Related Topics</h3>

<ul>

<li><a href="index.html">Documentation overview</a><ul>

</ul></li>

</ul>

</div>

<h3 id="searchlabel">Quick search</h3>

</form>

</div>

</div>

</div>

& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

<a href="_sources/arrayfire.array.rst.txt"

rel="nofollow">Page source</a>

</div>

</body>

</html>

Terms
Privacy
Security
Status
Community
Docs
Contact
Manage cookies
Do not share my personal information

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Files

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

Breadcrumbs

arrayfire.array.html

Latest commit

History

Breadcrumbs

arrayfire.array.html

File metadata and controls

Footer

Footer navigation

Files