1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 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
extern crate libc; use self::libc::{c_double, c_int, c_uint}; use crate::array::Array; use crate::defines::AfError; use crate::error::HANDLE_ERROR; use crate::seq::Seq; use crate::util::{AfArray, AfIndex, DimT, HasAfEnum, MutAfArray, MutAfIndex}; use std::marker::PhantomData; #[allow(dead_code)] extern "C" { fn af_create_indexers(indexers: MutAfIndex) -> c_int; fn af_set_array_indexer(indexer: AfIndex, idx: AfArray, dim: DimT) -> c_int; fn af_set_seq_indexer( indexer: AfIndex, idx: *const SeqInternal, dim: DimT, is_batch: c_int, ) -> c_int; fn af_release_indexers(indexers: AfIndex) -> c_int; fn af_index(out: MutAfArray, input: AfArray, ndims: c_uint, index: *const SeqInternal) -> c_int; fn af_lookup(out: MutAfArray, arr: AfArray, indices: AfArray, dim: c_uint) -> c_int; fn af_assign_seq( out: MutAfArray, lhs: AfArray, ndims: c_uint, indices: *const SeqInternal, rhs: AfArray, ) -> c_int; fn af_index_gen(out: MutAfArray, input: AfArray, ndims: DimT, indices: AfIndex) -> c_int; fn af_assign_gen( out: MutAfArray, lhs: AfArray, ndims: DimT, indices: AfIndex, rhs: AfArray, ) -> c_int; } /// Struct to manage an array of resources of type `af_indexer_t`(ArrayFire C struct) /// /// # Examples /// /// Given below are examples illustrating correct and incorrect usage of Indexer struct. /// /// <h3> Correct Usage </h3> /// /// ```rust /// use arrayfire::{Array, Dim4, randu, index_gen, Indexer}; /// /// // Always be aware of the fact that, the `Seq` or `Array` objects /// // that we intend to use for indexing via `Indexer` have to outlive /// // the `Indexer` object created in this context. /// /// let dims = Dim4::new(&[1, 3, 1, 1]); /// let indices = [1u8, 0, 1]; /// let idx = Array::new(&indices, dims); /// let values = [2.0f32, 5.0, 6.0]; /// let arr = Array::new(&values, dims); /// /// let mut idxr = Indexer::new(); /// /// // `idx` is created much before idxr, thus will /// // stay in scope at least as long as idxr /// idxr.set_index(&idx, 0, None); /// /// index_gen(&arr, idxr); /// ``` /// /// <h3> Incorrect Usage </h3> /// /// ```rust,ignore /// // Say, you create an Array on the fly and try /// // to call set_index, it will throw the given below /// // error or something similar to that /// idxr.set_index(&Array::new(&[1, 0, 1], dims), 0, None); /// ``` /// /// ```text /// error: borrowed value does not live long enough /// --> <anon>:16:55 /// | ///16 | idxr.set_index(&Array::new(&[1, 0, 1], dims), 0, None); /// | ---------------------------- ^ temporary value dropped here while still borrowed /// | | /// | temporary value created here ///... ///19 | } /// | - temporary value needs to live until here /// | /// = note: consider using a `let` binding to increase its lifetime /// ``` pub struct Indexer<'object> { handle: i64, count: usize, marker: PhantomData<&'object ()>, } /// Trait bound indicating indexability /// /// Any object to be able to be passed on to [Indexer::set_index()](./struct.Indexer.html#method.set_index) method should implement this trait with appropriate implementation of `set` method. pub trait Indexable { /// Set indexing object for a given dimension /// /// # Parameters /// /// - `idxr` is mutable reference to [Indexer](./struct.Indexer.html) object which will /// be modified to set `self` indexable along `dim` dimension. /// - `dim` is the dimension along which `self` indexable will be used for indexing. /// - `is_batch` is only used if `self` is [Seq](./struct.Seq.html) to indicate if indexing /// along `dim` is a batched operation. fn set(&self, idxr: &mut Indexer, dim: u32, is_batch: Option<bool>); } /// Enables [Array](./struct.Array.html) to be used to index another Array /// /// This is used in functions [index_gen](./fn.index_gen.html) and /// [assign_gen](./fn.assign_gen.html) impl<T: HasAfEnum> Indexable for Array<T> { #[allow(unused_variables)] fn set(&self, idxr: &mut Indexer, dim: u32, is_batch: Option<bool>) { unsafe { let err_val = af_set_array_indexer(idxr.get() as AfIndex, self.get() as AfArray, dim as DimT); HANDLE_ERROR(AfError::from(err_val)); } } } /// Enables [Seq](./struct.Seq.html) to be used to index another Array /// /// This is used in functions [index_gen](./fn.index_gen.html) and /// [assign_gen](./fn.assign_gen.html) impl<T: Copy> Indexable for Seq<T> where c_double: From<T>, { fn set(&self, idxr: &mut Indexer, dim: u32, is_batch: Option<bool>) { unsafe { let err_val = af_set_seq_indexer( idxr.get() as AfIndex, &SeqInternal::from_seq(self) as *const SeqInternal, dim as DimT, is_batch.unwrap() as c_int, ); HANDLE_ERROR(AfError::from(err_val)); } } } impl<'object> Indexer<'object> { #[allow(unused_mut)] /// Create a new Indexer object and set the dimension specific index objects later pub fn new() -> Self { let mut temp: i64 = 0; unsafe { let err_val = af_create_indexers(&mut temp as MutAfIndex); HANDLE_ERROR(AfError::from(err_val)); } Self { handle: temp, count: 0, marker: PhantomData, } } /// Set either [Array](./struct.Array.html) or [Seq](./struct.Seq.html) to index an Array along `idx` dimension pub fn set_index<'s, T>(&'s mut self, idx: &'object T, dim: u32, is_batch: Option<bool>) where T: Indexable + 'object, { idx.set(self, dim, is_batch); self.count = self.count + 1; } /// Get number of indexing objects set pub fn len(&self) -> usize { self.count } /// Get native(ArrayFire) resource handle pub fn get(&self) -> i64 { self.handle } } impl<'object> Drop for Indexer<'object> { fn drop(&mut self) { unsafe { let ret_val = af_release_indexers(self.handle as AfIndex); match ret_val { 0 => (), _ => panic!("Failed to release indexers resource: {}", ret_val), } } } } /// Indexes the `input` Array using `seqs` Sequences /// /// # Examples /// /// ```rust /// use arrayfire::{Dim4, Seq, index, randu, print}; /// let dims = Dim4::new(&[5, 5, 1, 1]); /// let a = randu::<f32>(dims); /// let seqs = &[Seq::new(1.0, 3.0, 1.0), Seq::default()]; /// let sub = index(&a, seqs); /// println!("a(seq(1, 3, 1), span)"); /// print(&sub); /// ``` pub fn index<IO, T: Copy>(input: &Array<IO>, seqs: &[Seq<T>]) -> Array<IO> where c_double: From<T>, IO: HasAfEnum, { let mut temp: i64 = 0; unsafe { // TODO: allocating a whole new array on the heap just for this is BAD let seqs: Vec<SeqInternal> = seqs.iter().map(|s| SeqInternal::from_seq(s)).collect(); let err_val = af_index( &mut temp as MutAfArray, input.get() as AfArray, seqs.len() as u32, seqs.as_ptr() as *const SeqInternal, ); HANDLE_ERROR(AfError::from(err_val)); } temp.into() } /// Extract `row_num` row from `input` Array /// /// # Examples /// /// ```rust /// use arrayfire::{Dim4, randu, row, print}; /// let dims = Dim4::new(&[5, 5, 1, 1]); /// let a = randu::<f32>(dims); /// println!("Grab last row of the random matrix"); /// print(&a); /// print(&row(&a, 4)); /// ``` #[allow(dead_code)] pub fn row<T>(input: &Array<T>, row_num: u64) -> Array<T> where T: HasAfEnum, { index( input, &[ Seq::new(row_num as f64, row_num as f64, 1.0), Seq::default(), ], ) } #[allow(dead_code)] /// Set `row_num`^th row in `input` Array to a new Array `new_row` pub fn set_row<T>(input: &Array<T>, new_row: &Array<T>, row_num: u64) -> Array<T> where T: HasAfEnum, { let seqs = [ Seq::new(row_num as f64, row_num as f64, 1.0), Seq::default(), ]; assign_seq(input, &seqs, new_row) } #[allow(dead_code)] /// Get an Array with all rows from `first` to `last` in the `input` Array pub fn rows<T>(input: &Array<T>, first: u64, last: u64) -> Array<T> where T: HasAfEnum, { index( input, &[Seq::new(first as f64, last as f64, 1.0), Seq::default()], ) } #[allow(dead_code)] /// Set rows from `first` to `last` in `input` Array with rows from Array `new_rows` pub fn set_rows<T>(input: &Array<T>, new_rows: &Array<T>, first: u64, last: u64) -> Array<T> where T: HasAfEnum, { let seqs = [Seq::new(first as f64, last as f64, 1.0), Seq::default()]; assign_seq(input, &seqs, new_rows) } /// Extract `col_num` col from `input` Array /// /// # Examples /// /// ```rust /// use arrayfire::{Dim4, randu, col, print}; /// let dims = Dim4::new(&[5, 5, 1, 1]); /// let a = randu::<f32>(dims); /// print(&a); /// println!("Grab last col of the random matrix"); /// print(&col(&a, 4)); /// ``` #[allow(dead_code)] pub fn col<T>(input: &Array<T>, col_num: u64) -> Array<T> where T: HasAfEnum, { index( input, &[ Seq::default(), Seq::new(col_num as f64, col_num as f64, 1.0), ], ) } #[allow(dead_code)] /// Set `col_num`^th col in `input` Array to a new Array `new_col` pub fn set_col<T>(input: &Array<T>, new_col: &Array<T>, col_num: u64) -> Array<T> where T: HasAfEnum, { let seqs = [ Seq::default(), Seq::new(col_num as f64, col_num as f64, 1.0), ]; assign_seq(input, &seqs, new_col) } #[allow(dead_code)] /// Get all cols from `first` to `last` in the `input` Array pub fn cols<T>(input: &Array<T>, first: u64, last: u64) -> Array<T> where T: HasAfEnum, { index( input, &[Seq::default(), Seq::new(first as f64, last as f64, 1.0)], ) } #[allow(dead_code)] /// Set cols from `first` to `last` in `input` Array with cols from Array `new_cols` pub fn set_cols<T>(input: &Array<T>, new_cols: &Array<T>, first: u64, last: u64) -> Array<T> where T: HasAfEnum, { let seqs = [Seq::default(), Seq::new(first as f64, last as f64, 1.0)]; assign_seq(input, &seqs, new_cols) } #[allow(dead_code)] /// Get `slice_num`^th slice from `input` Array /// /// Note. Slices indicate that the indexing is along 3rd dimension pub fn slice<T>(input: &Array<T>, slice_num: u64) -> Array<T> where T: HasAfEnum, { let seqs = [ Seq::default(), Seq::default(), Seq::new(slice_num as f64, slice_num as f64, 1.0), ]; index(input, &seqs) } #[allow(dead_code)] /// Set slice `slice_num` in `input` Array to a new Array `new_slice` /// /// Slices indicate that the indexing is along 3rd dimension pub fn set_slice<T>(input: &Array<T>, new_slice: &Array<T>, slice_num: u64) -> Array<T> where T: HasAfEnum, { let seqs = [ Seq::default(), Seq::default(), Seq::new(slice_num as f64, slice_num as f64, 1.0), ]; assign_seq(input, &seqs, new_slice) } #[allow(dead_code)] /// Get slices from `first` to `last` in `input` Array /// /// Slices indicate that the indexing is along 3rd dimension pub fn slices<T>(input: &Array<T>, first: u64, last: u64) -> Array<T> where T: HasAfEnum, { let seqs = [ Seq::default(), Seq::default(), Seq::new(first as f64, last as f64, 1.0), ]; index(input, &seqs) } #[allow(dead_code)] /// Set `first` to `last` slices of `input` Array to a new Array `new_slices` /// /// Slices indicate that the indexing is along 3rd dimension pub fn set_slices<T>(input: &Array<T>, new_slices: &Array<T>, first: u64, last: u64) -> Array<T> where T: HasAfEnum, { let seqs = [ Seq::default(), Seq::default(), Seq::new(first as f64, last as f64, 1.0), ]; assign_seq(input, &seqs, new_slices) } /// Lookup(hash) an Array using another Array /// /// Given a dimension `seq_dim`, `indices` are lookedup in `input` and returned as a new /// Array if found pub fn lookup<T, I>(input: &Array<T>, indices: &Array<I>, seq_dim: i32) -> Array<T> where T: HasAfEnum, I: HasAfEnum, { let mut temp: i64 = 0; unsafe { let err_val = af_lookup( &mut temp as MutAfArray, input.get() as AfArray, indices.get() as AfArray, seq_dim as c_uint, ); HANDLE_ERROR(AfError::from(err_val)); } temp.into() } /// Assign(copy) content of an Array to another Array indexed by Sequences /// /// Assign `rhs` to `lhs` after indexing `lhs` /// /// # Examples /// /// ```rust /// use arrayfire::{constant, Dim4, Seq, assign_seq, print}; /// let a = constant(2.0 as f32, Dim4::new(&[5, 3, 1, 1])); /// let b = constant(1.0 as f32, Dim4::new(&[3, 3, 1, 1])); /// let seqs = &[Seq::new(1.0, 3.0, 1.0), Seq::default()]; /// let sub = assign_seq(&a, seqs, &b); /// print(&a); /// // 2.0 2.0 2.0 /// // 2.0 2.0 2.0 /// // 2.0 2.0 2.0 /// // 2.0 2.0 2.0 /// // 2.0 2.0 2.0 /// /// print(&sub); /// // 2.0 2.0 2.0 /// // 1.0 1.0 1.0 /// // 1.0 1.0 1.0 /// // 1.0 1.0 1.0 /// // 2.0 2.0 2.0 /// ``` pub fn assign_seq<T: Copy, I>(lhs: &Array<I>, seqs: &[Seq<T>], rhs: &Array<I>) -> Array<I> where c_double: From<T>, I: HasAfEnum, { let mut temp: i64 = 0; // TODO: allocating a whole new array on the heap just for this is BAD let seqs: Vec<SeqInternal> = seqs.iter().map(|s| SeqInternal::from_seq(s)).collect(); unsafe { let err_val = af_assign_seq( &mut temp as MutAfArray, lhs.get() as AfArray, seqs.len() as c_uint, seqs.as_ptr() as *const SeqInternal, rhs.get() as AfArray, ); HANDLE_ERROR(AfError::from(err_val)); } temp.into() } /// Index an Array using any combination of Array's and Sequence's /// /// # Examples /// /// ```rust /// use arrayfire::{Array, Dim4, Seq, print, randu, index_gen, Indexer}; /// let values: [f32; 3] = [1.0, 2.0, 3.0]; /// let indices = Array::new(&values, Dim4::new(&[3, 1, 1, 1])); /// let seq4gen = Seq::new(0.0, 2.0, 1.0); /// let a = randu::<f32>(Dim4::new(&[5, 3, 1, 1])); /// // [5 3 1 1] /// // 0.0000 0.2190 0.3835 /// // 0.1315 0.0470 0.5194 /// // 0.7556 0.6789 0.8310 /// // 0.4587 0.6793 0.0346 /// // 0.5328 0.9347 0.0535 /// /// /// let mut idxrs = Indexer::new(); /// idxrs.set_index(&indices, 0, None); // 2nd parameter is indexing dimension /// idxrs.set_index(&seq4gen, 1, Some(false)); // 3rd parameter indicates batch operation /// /// let sub2 = index_gen(&a, idxrs); /// println!("a(indices, seq(0, 2, 1))"); print(&sub2); /// // [3 3 1 1] /// // 0.1315 0.0470 0.5194 /// // 0.7556 0.6789 0.8310 /// // 0.4587 0.6793 0.0346 /// ``` pub fn index_gen<T>(input: &Array<T>, indices: Indexer) -> Array<T> where T: HasAfEnum, { let mut temp: i64 = 0; unsafe { let err_val = af_index_gen( &mut temp as MutAfArray, input.get() as AfArray, indices.len() as DimT, indices.get() as AfIndex, ); HANDLE_ERROR(AfError::from(err_val)); } temp.into() } /// Assign an Array to another after indexing it using any combination of Array's and Sequence's /// /// # Examples /// /// ```rust /// use arrayfire::{Array, Dim4, Seq, print, randu, constant, Indexer, assign_gen}; /// let values: [f32; 3] = [1.0, 2.0, 3.0]; /// let indices = Array::new(&values, Dim4::new(&[3, 1, 1, 1])); /// let seq4gen = Seq::new(0.0, 2.0, 1.0); /// let a = randu::<f32>(Dim4::new(&[5, 3, 1, 1])); /// // [5 3 1 1] /// // 0.0000 0.2190 0.3835 /// // 0.1315 0.0470 0.5194 /// // 0.7556 0.6789 0.8310 /// // 0.4587 0.6793 0.0346 /// // 0.5328 0.9347 0.0535 /// /// let b = constant(2.0 as f32, Dim4::new(&[3, 3, 1, 1])); /// /// let mut idxrs = Indexer::new(); /// idxrs.set_index(&indices, 0, None); // 2nd parameter is indexing dimension /// idxrs.set_index(&seq4gen, 1, Some(false)); // 3rd parameter indicates batch operation /// /// let sub2 = assign_gen(&a, &idxrs, &b); /// println!("a(indices, seq(0, 2, 1))"); print(&sub2); /// // [5 3 1 1] /// // 0.0000 0.2190 0.3835 /// // 2.0000 2.0000 2.0000 /// // 2.0000 2.0000 2.0000 /// // 2.0000 2.0000 2.0000 /// // 0.5328 0.9347 0.0535 /// ``` pub fn assign_gen<T>(lhs: &Array<T>, indices: &Indexer, rhs: &Array<T>) -> Array<T> where T: HasAfEnum, { let mut temp: i64 = 0; unsafe { let err_val = af_assign_gen( &mut temp as MutAfArray, lhs.get() as AfArray, indices.len() as DimT, indices.get() as AfIndex, rhs.get() as AfArray, ); HANDLE_ERROR(AfError::from(err_val)); } temp.into() } #[repr(C)] struct SeqInternal { begin: c_double, end: c_double, step: c_double, } impl SeqInternal { fn from_seq<T: Copy>(s: &Seq<T>) -> Self where c_double: From<T>, { Self { begin: From::from(s.begin()), end: From::from(s.end()), step: From::from(s.step()), } } }