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 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
use{
crate::*,
transpose::*,
std::{io::Write, borrow::*}
};
#[cfg(feature = "serde_support")]
use serde::{Serialize, Deserialize};
/// # Get index of heatmap corresponding to a coordinate
#[inline(always)]
pub fn heatmap_index(width: usize, x: usize, y: usize) -> usize
{
y * width + x
}
/// # Heatmap
/// * stores heatmap in row-major order: the rows of the heatmap are contiguous,
/// and the columns are strided
/// * enables you to quickly create a heatmap
/// * you can create gnuplot scripts to plot the heatmap
/// * you can transpose the heatmap
/// * …
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde_support", derive(Serialize, Deserialize))]
pub struct HeatmapUsize<HistWidth, HistHeight>{
pub(crate) hist_width: HistWidth,
pub(crate) hist_height: HistHeight,
pub(crate) width: usize,
pub(crate) height: usize,
pub(crate) heatmap: Vec<usize>, // stored width, height
pub(crate) error_count: usize
}
/// Shorthand for HeatmapUsize
pub type HeatmapU<HistWidth, HistHeight> = HeatmapUsize<HistWidth, HistHeight>;
#[cfg(feature="bootstrap")]
impl<HistWidth, HistHeight> From<HeatmapUsizeMean<HistWidth, HistHeight>> for HeatmapU<HistWidth, HistHeight>
{
fn from(heatmap_mean: HeatmapUsizeMean<HistWidth, HistHeight>) -> Self {
heatmap_mean.heatmap
}
}
impl <HistWidth, HistHeight> HeatmapUsize<HistWidth, HistHeight>
where
HistWidth: Clone,
HistHeight: Clone,
{
/// # Use this to get a "flipped" heatmap
/// * creates a transposed heatmap
/// * also look at [`self.transpose_inplace`](#method.transpose_inplace)
pub fn transpose(&self) -> HeatmapUsize<HistHeight, HistWidth>
{
let mut transposed = vec![0; self.heatmap.len()];
transpose(
&self.heatmap,
&mut transposed,
self.width,
self.height
);
HeatmapUsize{
hist_width: self.hist_height.clone(),
hist_height: self.hist_width.clone(),
width: self.height,
height: self.width,
error_count: self.error_count,
heatmap: transposed,
}
}
}
impl <HistWidth, HistHeight> HeatmapUsize<HistWidth, HistHeight>
{
/// # Use this to get a "flipped" heatmap
/// * transposes the heatmap inplace
pub fn transpose_inplace(mut self) -> HeatmapUsize<HistHeight, HistWidth>
{
let mut scratch = vec![0; self.width.max(self.height)];
transpose_inplace(&mut self.heatmap, &mut scratch, self.width, self.height);
HeatmapUsize{
hist_width: self.hist_height,
hist_height: self.hist_width,
width: self.height,
height: self.width,
error_count: self.error_count,
heatmap: self.heatmap
}
}
/// x = j
/// y = i
#[inline(always)]
fn index(&self, x: usize, y: usize) -> usize
{
heatmap_index(self.width, x, y)
}
/// Returns value stored in the heatmap at specified
/// coordinates, or `None`, if out of Bounds
pub fn get(&self, x: usize, y: usize) -> Option<usize>
{
self.heatmap.get(self.index(x, y)).copied()
}
/// # row of the heatmap
/// * `None` if out of bounds
/// * otherwise it is a slice of the row at height `y`
/// # Note
/// * there is no `get_column` method, because, due to implementation details,
/// it is way less efficient, and could not be returned as slice
pub fn get_row(&self, y: usize) -> Option<&[usize]>
{
let fin = self.index(self.width, y);
if fin > self.heatmap.len(){
None
} else {
let start = fin - self.width;
Some(
&self.heatmap[start..fin]
)
}
}
/// Returns value stored in the heatmap at specified
/// coordinates without performing bound checks.
/// ## Safety
/// **undefined behavior** if coordinates are out of bounds
pub unsafe fn get_unchecked(&self, x: usize, y: usize) -> usize
{
*self.heatmap.get_unchecked(self.index(x, y))
}
/// # returns width of the heatmap
/// * the width is the same size, as the `self.width_projection().bin_count()`
pub fn width(&self) -> usize
{
self.width
}
/// # returns height of the heatmap
/// * the height is the same size, as the `self.height_projection().bin_count()`
pub fn height(&self) -> usize
{
self.height
}
/// # Returns reference to current width Histogram
/// * histogram used to bin in the "width" direction
/// * all `counts` are counted here -> this is a projection of the heatmap
pub fn width_hist(&self) -> &HistWidth{
&self.hist_width
}
/// # Returns reference to current height Histogram
/// * histogram used to bin in the "height" direction
/// * all `counts` are counted here -> this is a projection of the heatmap
pub fn height_hist(&self) -> &HistHeight{
&self.hist_height
}
}
impl<HistWidth, HistHeight> HeatmapUsize<HistWidth, HistHeight>
where
HistWidth: Histogram,
HistHeight: Histogram,
{
/// # Create a new Heatmap
/// * heatmap will have width `width_hist.bin_count()`
/// and height `height_hist.bin_count()`
/// * histograms will be reset (zeroed) here, so it does not matter, if they
/// were used before and contain Data
pub fn new(mut width_hist: HistWidth, mut height_hist: HistHeight) -> Self {
let width = width_hist.bin_count();
let height = height_hist.bin_count();
width_hist.reset();
height_hist.reset();
let heatmap = vec![0; width * height];
Self{
width,
height,
heatmap,
hist_width: width_hist,
hist_height: height_hist,
error_count: 0
}
}
/// # Reset
/// * resets histograms
/// * heatmap is reset to contain only 0's
/// * miss_count is reset to 0
pub fn reset(&mut self)
{
self.hist_width.reset();
self.hist_height.reset();
self.heatmap.iter_mut().for_each(|v| *v = 0);
self.error_count = 0;
}
/// # "combine" heatmaps
/// * heatmaps will be combined by adding all entrys of `other` to `self`
/// * heatmaps have to have the same dimensions
pub fn combine<OtherHW, OtherHH>(&mut self, other: &HeatmapUsize<OtherHW, OtherHH>) -> Result<(), HeatmapError>
where OtherHW: Histogram,
OtherHH: Histogram,
{
if self.width != other.width || self.height != other.height
{
return Err(HeatmapError::Dimension);
}
self.heatmap
.iter_mut()
.zip(
other.heatmap.iter()
).for_each(
|(this, other)|
{
*this += other;
}
);
for (i, &count) in other.hist_width.hist().iter().enumerate()
{
self.hist_width
.count_multiple_index(i, count)
.unwrap()
}
for (i, &count) in other.hist_height.hist().iter().enumerate()
{
self.hist_height
.count_multiple_index(i, count)
.unwrap()
}
self.error_count += other.error_count;
Ok(())
}
/// # counts how often the heatmap was hit
/// * should be equal to `self.heatmap.iter().sum::<usize>()` but more efficient
/// * Note: it calculates this in O(min(self.width, self.height))
pub fn total(&self) -> usize {
if self.width <= self.height {
self.hist_width.hist().iter().sum()
} else {
self.hist_height.hist().iter().sum()
}
}
/// check if at least one bin was hit
fn any_hit(&self) -> bool {
let hist_vec =
if self.width <= self.height {
self.hist_width
.hist()
} else {
self.hist_height
.hist()
};
hist_vec
.iter()
.any(|&val| val != 0)
}
/// # Counts how often the Heatmap was missed, i.e., you tried to count a value (x,y), which was outside the Heatmap
pub fn total_misses(&self) -> usize
{
self.error_count
}
/// # counts how many bins of the heatmap where hit at least once
pub fn bins_hit(&self) -> usize
{
self.heatmap
.iter()
.filter(|&&val| val > 0)
.count()
}
/// # counts how many bins of the heatmap where never hit
pub fn bins_not_hit(&self) -> usize
{
self.heatmap
.iter()
.filter(|&&val| val == 0)
.count()
}
/// # returns heatmap
/// * each vector entry will contain the number of times, the corresponding bin was hit
/// * an entry is 0 if it was never hit
/// # Access indices; understanding how the data is mapped
/// * A specific heatmap location `(x,y)`
/// corresponds to the index `y * self.width() + x`
/// * you can use the `heatmap_index` function to calculate the index
pub fn heatmap(&self) -> &Vec<usize>
{
&self.heatmap
}
/// # returns Vector representing normalized heatmap
/// * Vector contains only 0.0, if nothing was in the heatmap
/// * otherwise the sum of this Vector is 1.0 (or at least very close to 1.0)
/// # Access indices; understanding how the data is mapped
/// * A specific heatmap location (x,y)
/// corresponds to the index `y * self.width() + x`
/// * you can use the function `heatmap_index(width, x, y)` for calculating the index
pub fn vec_normalized(&self) -> Vec<f64>
{
let total = self.total();
if total == 0 {
vec![0.0; self.heatmap.len()]
} else {
let total = total as f64;
let mut res = Vec::with_capacity(self.heatmap.len());
res.extend(
self.heatmap.iter()
.map(|&val| val as f64 / total)
);
res
}
}
/// # returns normalized heatmap
/// * returns normalized heatmap as `HeatmapF64`
/// * Heatmap vector `self.heatmap_normalized().heatmap()` contains only 0.0, if nothing was in the heatmap
/// * otherwise the sum of this Vector is 1.0 (within numerical errors)
pub fn heatmap_normalized(&self) -> HeatmapF64<HistWidth, HistHeight>
where HistHeight: Clone,
HistWidth: Clone
{
let heatmap_vec = self.vec_normalized();
HeatmapF64{
heatmap: heatmap_vec,
hist_height: self.hist_height.clone(),
hist_width: self.hist_width.clone(),
error_count: self.error_count,
width: self.width,
height: self.height
}
}
/// # returns normalized heatmap
/// * returns normalized heatmap as `HeatmapF64`
/// * Heatmap vector `self.heatmap_normalized().heatmap()` contains only 0.0, if nothing was in the heatmap
/// * otherwise the sum of this Vector is 1.0 (within numerical errors)
pub fn into_heatmap_normalized(self) -> HeatmapF64<HistWidth, HistHeight>
{
let heatmap_vec = self.vec_normalized();
HeatmapF64{
heatmap: heatmap_vec,
hist_height: self.hist_height,
hist_width: self.hist_width,
error_count: self.error_count,
width: self.width,
height: self.height
}
}
/// # returns vector representing heatmap, normalized column wise
/// * Vector contains only 0.0, if nothing was in the heatmap
/// * otherwise the sum of each column (fixed x) will be 1.0 (within numerical errors), if it contained at least one hit.
/// If it did not, the column will only consist of 0.0
/// # Access indices; understanding how the data is mapped
/// A specific heatmap location (x,y)
/// corresponds to the index `y * self.width() + x`
/// * you can use the function `heatmap_index(width, x, y)` for calculating the index
pub fn vec_normalized_columns(&self) -> Vec<f64>
{
let mut res = vec![0.0; self.heatmap.len()];
if !self.any_hit() {
return res;
}
for x in 0..self.width {
let column_sum: usize = (0..self.height)
.map(|y| unsafe{self.get_unchecked(x, y)})
.sum();
if column_sum > 0 {
let denominator = column_sum as f64;
for y in 0..self.height {
let index = self.index(x, y);
unsafe {
*res.get_unchecked_mut(index) = *self.heatmap.get_unchecked(index) as f64 / denominator;
}
}
}
}
res
}
/// # returns (column wise) normalized heatmap
/// * returns normalized heatmap as `HeatmapF64`
/// * Heatmap vector `self.heatmap_normalized().heatmap()` contains only 0.0, if nothing was in the heatmap
/// * otherwise the sum of each column (fixed x) will be 1.0 (within numerical errors), if it contained at least one hit.
/// If it did not, the column will only consist of 0.0
/// * otherwise the sum of this Vector is 1.0
pub fn heatmap_normalized_columns(&self) -> HeatmapF64<HistWidth, HistHeight>
where HistHeight: Clone,
HistWidth: Clone
{
let heatmap_vec = self.vec_normalized_columns();
HeatmapF64{
heatmap: heatmap_vec,
hist_height: self.hist_height.clone(),
hist_width: self.hist_width.clone(),
error_count: self.error_count,
width: self.width,
height: self.height
}
}
/// # returns (column wise) normalized heatmap
/// * returns normalized heatmap as `HeatmapF64`
/// * Heatmap vector `self.heatmap_normalized().heatmap()` contains only 0.0, if nothing was in the heatmap
/// * otherwise the sum of each column (fixed x) will be 1.0 (within numerical errors), if it contained at least one hit.
/// If it did not, the column will only consist of 0.0
/// * otherwise the sum of this Vector is 1.0
pub fn into_heatmap_normalized_columns(self) -> HeatmapF64<HistWidth, HistHeight>
{
let heatmap_vec = self.vec_normalized_columns();
HeatmapF64{
heatmap: heatmap_vec,
hist_height: self.hist_height,
hist_width: self.hist_width,
error_count: self.error_count,
width: self.width,
height: self.height
}
}
/// # returns vector representing heatmap, normalized row wise
/// * Vector contains only 0.0, if nothing was in the heatmap
/// * otherwise the sum of each row (fixed x) will be 1.0 (within numerical errors), if it contained at least one hit.
/// If it did not, the row will only consist of 0.0
/// # Access indices; understanding how the data is mapped
/// A specific heatmap location (x,y)
/// corresponds to the index `y * self.width() + x`
/// * you can use the function `heatmap_index(width, x, y)` for calculating the index
pub fn vec_normalized_rows(&self) -> Vec<f64>
{
let mut res = vec![0.0; self.heatmap.len()];
if !self.any_hit() {
return res;
}
for y in 0..self.height {
let start_index = self.index(0, y);
let fin = start_index + self.width;
let row_slice = &self.heatmap[start_index..fin];
let row_sum = row_slice.iter()
.sum::<usize>();
if row_sum > 0 {
let denominator = row_sum as f64;
let res_slice = &mut res[start_index..fin];
for (res_val, &heat_val) in res_slice
.iter_mut()
.zip(row_slice.iter())
{
*res_val = heat_val as f64 / denominator;
}
}
}
res
}
/// # returns (row wise) normalized heatmap
/// * returns normalized heatmap as `HeatmapF64`
/// * Heatmap vector `self.heatmap_normalized().heatmap()` contains only 0.0, if nothing was in the heatmap
/// * otherwise the sum of each row (fixed x) will be 1.0 (within numerical errors), if it contained at least one hit.
/// If it did not, the row will only consist of 0.0
/// * otherwise the sum of this Vector is 1.0
pub fn heatmap_normalized_rows(&self) -> HeatmapF64<HistWidth, HistHeight>
where HistHeight: Clone,
HistWidth: Clone
{
let heatmap_vec = self.vec_normalized_rows();
HeatmapF64{
heatmap: heatmap_vec,
hist_height: self.hist_height.clone(),
hist_width: self.hist_width.clone(),
error_count: self.error_count,
width: self.width,
height: self.height
}
}
/// # returns (row wise) normalized heatmap
/// * returns normalized heatmap as `HeatmapF64`
/// * Heatmap vector `self.heatmap_normalized().heatmap()` contains only 0.0, if nothing was in the heatmap
/// * otherwise the sum of each row (fixed x) will be 1.0 (within numerical errors), if it contained at least one hit.
/// If it did not, the row will only consist of 0.0
/// * otherwise the sum of this Vector is 1.0
pub fn into_heatmap_normalized_rows(self) -> HeatmapF64<HistWidth, HistHeight>
{
let heatmap_vec = self.vec_normalized_rows();
HeatmapF64{
heatmap: heatmap_vec,
hist_height: self.hist_height,
hist_width: self.hist_width,
error_count: self.error_count,
width: self.width,
height: self.height
}
}
/// # update the heatmap
/// * calculates the coordinates `(x, y)` of the bin corresponding
/// to the given values pair `(width_iter_entry, height_val)`
/// * as soon as a coordinate is encountered that is out of bounds, it counts a "miss" and returns the HeatmapError,
/// aborting further execution
/// * otherwise it counts the "hits" and returns the total number of hits added `usize`
pub fn count_multiple<A, B, X, Y, I>(&mut self, width_val_iter: I, height_val: B) -> Result<usize, HeatmapError>
where
HistWidth: HistogramVal<X>,
HistHeight: HistogramVal<Y>,
A: Borrow<X>,
B: Borrow<Y>,
I: Iterator<Item = A>
{
let hight = self.hist_height.get_bin_index(height_val)
.map_err(|e| {
self.error_count += 1;
HeatmapError::YError(e)
}
)?;
let mut counter = 0;
let y = hight * self.width;
for val in width_val_iter
{
counter += 1;
let x = self.hist_width
.count_val(val)
.map_err(|e| {
self.error_count += 1;
HeatmapError::XError(e)
}
)?;
let index = y + x;
self.heatmap[index] += 1;
}
self.hist_height
.count_multiple_index(hight, counter)
.unwrap();
Ok(counter)
}
/// # update the heatmap
/// * calculates the coordinate `(x, y)` of the bin corresponding
/// to the given value pair `(width_val, height_val)`
/// * if coordinate is out of bounds, it counts a "miss" and returns the HeatmapError
/// * otherwise it counts the "hit" and returns the coordinate `(x, y)`
pub fn count<A, B, X, Y>(&mut self, width_val: A, height_val: B) -> Result<(usize, usize), HeatmapError>
where
HistWidth: HistogramVal<X>,
HistHeight: HistogramVal<Y>,
A: Borrow<X>,
B: Borrow<Y>
{
let x = self.hist_width
.get_bin_index(width_val)
.map_err(|e| {
self.error_count += 1;
HeatmapError::XError(e)
}
)?;
let y = self.hist_height
.count_val(height_val)
.map_err(|e| {
self.error_count += 1;
HeatmapError::YError(e)
}
)?;
let index = self.index(x, y);
unsafe{
*self.heatmap.get_unchecked_mut(index) += 1;
}
self.hist_width
.count_index(x)
.unwrap();
Ok((x, y))
}
/// # Write heatmap to file
/// * writes data of heatmap to file.
/// # file
/// * lets assume `self.width()`is 4 and `self.height()` is 3
/// * the resulting file could look like
/// ```txt
/// 0 1 0 10
/// 100 0 0 1
/// 2 9 1 0
/// ```
pub fn write_to<W>(&self, mut data_file: W) -> std::io::Result<()>
where W: Write
{
for y in 0..self.height {
let row = self.get_row(y).unwrap();
if let Some((last, slice)) = row.split_last() {
for val in slice {
write!(data_file, "{} ", val)?;
}
writeln!(data_file, "{}", last)?;
}
}
Ok(())
}
/// # Create a gnuplot script to plot your heatmap
/// * `writer`: The gnuplot script will be written to this
/// * `gnuplot_output_name`: how shall the file, created by executing gnuplot,
/// be called? Ending of file will be set automatically
/// # Note
/// * This is the same as calling [`gnuplot`](Self::gnuplot) with default
/// `GnuplotSettings`
/// * The default axis are the bin indices, which, e.g, means they always
/// begin at 0. You have to set the axis via the [GnuplotSettings](crate::heatmap::GnuplotSettings)
pub fn gnuplot_quick<W>(
&self,
writer: W
) -> std::io::Result<()>
where
W: std::io::Write
{
self.gnuplot(
writer,
GnuplotSettings::default()
)
}
/// # Create a gnuplot script to plot your heatmap
/// This function writes a file, that can be plotted via the terminal via [gnuplot](http://www.gnuplot.info/)
/// ```bash
/// gnuplot gnuplot_file
/// ```
/// ## Parameter:
/// * `gnuplot_writer`: writer gnuplot script will be written to
/// * `gnuplot_output_name`: how shall the file, created by executing gnuplot, be called? Ending of file will be set automatically
/// * `settings`: Here you can set the axis, choose between terminals and more.
/// I recommend that you take a look at [GnuplotSettings](crate::heatmap::GnuplotSettings)
/// ## Note
/// The default axis are the bin indices, which, e.g, means they always
/// begin at 0. You have to set the axis via the [GnuplotSettings](crate::heatmap::GnuplotSettings)
/// ## Example
/// ```
/// use rand_pcg::Pcg64;
/// use rand::{SeedableRng, distributions::*};
/// use sampling::*;
/// use std::fs::File;
/// use std::io::BufWriter;
///
/// // first randomly create a heatmap
/// let h_x = HistUsizeFast::new_inclusive(0, 10).unwrap();
/// let h_y = HistU8Fast::new_inclusive(0, 10).unwrap();
///
/// let mut heatmap = HeatmapU::new(h_x, h_y);
/// heatmap.count(0, 0).unwrap();
/// heatmap.count(10, 0).unwrap();
///
/// let mut rng = Pcg64::seed_from_u64(27456487);
/// let x_distr = Uniform::new_inclusive(0, 10_usize);
/// let y_distr = Uniform::new_inclusive(0, 10_u8);
///
/// for _ in 0..100000 {
/// let x = x_distr.sample(&mut rng);
/// let y = y_distr.sample(&mut rng);
/// heatmap.count(x, y).unwrap();
/// }
///
/// // create File for gnuplot script
/// let file = File::create("heatmap.gp").unwrap();
/// let buf = BufWriter::new(file);
///
/// // Choose settings for gnuplot
/// let mut settings = GnuplotSettings::new();
/// settings.x_axis(GnuplotAxis::new(-5.0, 5.0, 6))
/// .y_axis(GnuplotAxis::from_slice(&["a", "b", "c", "d"]))
/// .y_label("letter")
/// .x_label("number")
/// .title("Example")
/// .terminal(GnuplotTerminal::PDF("heatmap".to_owned()));
///
/// // create gnuplot script
/// heatmap.gnuplot(
/// buf,
/// settings
/// ).unwrap();
/// ```
/// gnuplot script can now be plotted with
/// ```bash
/// gnuplot heatmap.gp
/// ```
pub fn gnuplot<W, GS>(
&self,
mut gnuplot_writer: W,
settings: GS
) -> std::io::Result<()>
where
W: Write,
GS: Borrow<GnuplotSettings>
{
let settings: &GnuplotSettings = settings.borrow();
let x_len = self.width;
let y_len = self.height;
settings.write_heatmap(
&mut gnuplot_writer,
|w| self.write_to(w),
x_len,
y_len
)
}
}
#[cfg(test)]
mod tests{
use rand_pcg::Pcg64;
use rand::distributions::*;
use rand::SeedableRng;
use super::*;
#[test]
fn equality_test()
{
let h_y = HistUsizeFast::new_inclusive(0, 10).unwrap();
let h_x = HistU8Fast::new_inclusive(0, 16).unwrap();
let mut heatmap = HeatmapUsize::new(h_x, h_y);
let mut heatmap_2 = heatmap.clone();
let mut rng = Pcg64::seed_from_u64(27456487);
let uniform = Uniform::new_inclusive(0, 16);
for i in 0..10
{
let vals: Vec<_> = (&uniform).sample_iter(&mut rng).take(100).collect();
for val in vals.iter()
{
heatmap.count(val, i).unwrap();
}
heatmap_2.count_multiple(vals.into_iter(), i).unwrap();
}
// now check equality
heatmap
.heatmap()
.iter()
.zip(heatmap_2.heatmap().iter())
.for_each(|(&a, &b)| assert_eq!(a, b));
heatmap.height_hist().hist().iter()
.zip(heatmap_2.height_hist().hist().iter())
.for_each(|(&a, &b)| assert_eq!(a, b));
heatmap_2.width_hist().hist().iter()
.zip(heatmap.width_hist().hist().iter())
.for_each(|(&a, &b)| assert_eq!(a, b));
}
#[test]
fn row_test()
{
let h_x = HistUsizeFast::new_inclusive(0, 10).unwrap();
let h_y = HistU8Fast::new_inclusive(0, 6).unwrap();
let mut heatmap = HeatmapUsize::new(h_x, h_y);
let mut rng = Pcg64::seed_from_u64(27456487);
let x_distr = Uniform::new_inclusive(0, 10_usize);
let y_distr = Uniform::new_inclusive(0, 6_u8);
for _ in 0..100 {
let x = x_distr.sample(&mut rng);
let y = y_distr.sample(&mut rng);
heatmap.count(x, y).unwrap();
}
let mut iter = heatmap.heatmap().iter();
for y in 0..heatmap.height()
{
let row = heatmap.get_row(y).unwrap();
assert_eq!(row.len(), heatmap.width());
for val in row
{
assert_eq!(val, iter.next().unwrap());
}
}
}
#[test]
fn combine_test()
{
let h_x = HistUsizeFast::new_inclusive(0, 10).unwrap();
let h_y = HistU8Fast::new_inclusive(0, 6).unwrap();
let mut heatmap = HeatmapUsize::new(h_x, h_y);
let mut rng = Pcg64::seed_from_u64(27456487);
let x_distr = Uniform::new_inclusive(0, 10_usize);
let y_distr = Uniform::new_inclusive(0, 6_u8);
for _ in 0..100 {
let x = x_distr.sample(&mut rng);
let y = y_distr.sample(&mut rng);
heatmap.count(x, y).unwrap();
}
let c = heatmap.clone();
heatmap.combine(&c).unwrap();
}
#[test]
fn plot_test()
{
let h_x = HistUsizeFast::new_inclusive(0, 10).unwrap();
let h_y = HistU8Fast::new_inclusive(0, 10).unwrap();
let mut heatmap = HeatmapUsize::new(h_x, h_y);
let mut rng = Pcg64::seed_from_u64(27456487);
let x_distr = Uniform::new_inclusive(0, 10_usize);
let y_distr = Uniform::new_inclusive(0, 10_u8);
for _ in 0..100000 {
let x = x_distr.sample(&mut rng);
let y = y_distr.sample(&mut rng);
heatmap.count(x, y).unwrap();
}
// heatmap.gnuplot(
// "EPS.gp",
// "EPS",
// "EPS_DATA",
// HeatmapNormalization::NormalizeRow,
// GnuplotTerminal::EpsLatex,
// ).unwrap();
for x in 0..heatmap.width() {
let mut sum = 0;
for y in 0..heatmap.height()
{
sum += heatmap.get(x, y).unwrap();
}
assert_eq!(sum, heatmap.width_hist().hist()[x]);
}
for y in 0..heatmap.height() {
let mut sum = 0;
for x in 0..heatmap.width()
{
sum += heatmap.get(x, y).unwrap();
}
assert_eq!(sum, heatmap.height_hist().hist()[y]);
}
let normed = heatmap.vec_normalized_columns();
for x in 0..heatmap.width() {
let mut sum = 0.0;
for y in 0..heatmap.height()
{
sum += normed[heatmap.index(x, y)];
}
assert!((sum - 1.0).abs() < 1e-10);
}
let normed = heatmap.vec_normalized_rows();
for y in 0..heatmap.height() {
let mut sum = 0.0;
for x in 0..heatmap.width()
{
sum += normed[heatmap.index(x, y)];
}
assert!((sum - 1.0).abs() < 1e-10);
}
}
#[test]
fn transpose_test()
{
let h_x = HistUsizeFast::new_inclusive(0, 10).unwrap();
let h_y = HistU8Fast::new_inclusive(0, 5).unwrap();
let mut heatmap = HeatmapUsize::new(h_x, h_y);
let mut rng = Pcg64::seed_from_u64(27456487);
let x_distr = Uniform::new_inclusive(0, 10_usize);
let y_distr = Uniform::new_inclusive(0, 5_u8);
for _ in 0..10 {
let x = x_distr.sample(&mut rng);
let y = y_distr.sample(&mut rng);
heatmap.count(x, y).unwrap();
}
// heatmap.gnuplot(
// "heatmapT.gp",
// "heatmapT",
// "heatmap_dataT",
// HeatmapNormalization::AsIs,
// GnuplotTerminal::PDF,
// ).unwrap();
let heatmap_t = heatmap.transpose();
// heatmap_t.gnuplot(
// "heatmapT_T.gp",
// "heatmapT_T",
// "heatmap_dataT_T",
// HeatmapNormalization::AsIs,
// GnuplotTerminal::PDF,
// ).unwrap();
let heatmap_i = heatmap.transpose_inplace();
// heatmap_i.gnuplot(
// "heatmapT_I.gp",
// "heatmapT_I",
// "heatmap_dataT_I",
// HeatmapNormalization::AsIs,
// GnuplotTerminal::PDF,
// ).unwrap();
for (val1, val2) in heatmap_i.heatmap().iter().zip(heatmap_t.heatmap().iter())
{
assert_eq!(val1, val2);
}
for x in 0..heatmap_i.width() {
let mut sum = 0;
for y in 0..heatmap_i.height()
{
sum += heatmap_i.get(x, y).unwrap();
}
assert_eq!(sum, heatmap_i.width_hist().hist()[x]);
}
for y in 0..heatmap_i.height() {
let mut sum = 0;
for x in 0..heatmap_i.width()
{
sum += heatmap_i.get(x, y).unwrap();
}
assert_eq!(sum, heatmap_i.height_hist().hist()[y]);
}
}
}