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
use super::{vector_to_array, AsVector, GraphMaker};
use crate::quote_marker;
use std::fmt::Write;
/// Holds either the second point coordinates of a ray or the slope of the ray
#[derive(Clone, Debug)]
pub enum RayEndpoint {
/// Coordinates of the second point
Coords(f64, f64),
/// Slope of the ray
Slope(f64),
/// Indicates a horizontal ray
Horizontal,
/// Indicates a vertical ray
Vertical,
}
/// Generates a curve (aka line-plot) given two arrays (x,y)
///
/// # Notes
///
/// * This struct corresponds to the **plot** function of Matplotlib.
/// * You may plot a Scatter plot by setting line_style = "None"
///
/// # Examples
///
/// ## Using methods to set the points
///
/// ```
/// use plotpy::{Curve, Plot, StrError};
/// use std::f64::consts::PI;
///
/// fn main() -> Result<(), StrError> {
/// // configure curve
/// let mut curve = Curve::new();
/// curve.set_line_width(2.0);
///
/// // add points
/// const N: usize = 30;
/// curve.points_begin();
/// for i in 0..N {
/// let x = (i as f64) * 2.0 * PI / ((N - 1) as f64);
/// let y = f64::sin(x);
/// curve.points_add(x, y);
/// }
/// curve.points_end();
///
/// // add curve to plot
/// let mut plot = Plot::new();
/// plot.add(&curve).grid_and_labels("x", "y");
///
/// // configure multiple-of-pi formatter
/// let minor_every = PI / 12.0;
/// plot.set_ticks_x_multiple_of_pi(minor_every);
///
/// // save figure
/// plot.save("/tmp/plotpy/doc_tests/doc_curve_methods.svg")?;
/// Ok(())
/// }
/// ```
///
/// ![doc_curve_methods.svg](https://raw.githubusercontent.com/cpmech/plotpy/main/figures/doc_curve_methods.svg)
///
/// ## Using Vector with point data
///
/// ```
/// use plotpy::{linspace, Curve, Plot, StrError};
///
/// fn main() -> Result<(), StrError> {
/// // generate (x,y) points
/// let x = linspace(-1.0, 1.0, 21);
/// let y: Vec<_> = x.iter().map(|v| 1.0 / (1.0 + f64::exp(-5.0 * *v))).collect();
///
/// // configure curve
/// let mut curve = Curve::new();
/// curve
/// .set_label("logistic function")
/// .set_line_alpha(0.8)
/// .set_line_color("#5f9cd8")
/// .set_line_style("-")
/// .set_line_width(5.0)
/// .set_marker_color("#eeea83")
/// .set_marker_every(5)
/// .set_marker_line_color("#da98d1")
/// .set_marker_line_width(2.5)
/// .set_marker_size(20.0)
/// .set_marker_style("*");
///
/// // draw curve
/// curve.draw(&x, &y);
///
/// // add curve to plot
/// let mut plot = Plot::new();
/// plot.add(&curve).set_num_ticks_y(11).grid_labels_legend("x", "y");
///
/// // save figure
/// plot.save("/tmp/plotpy/doc_tests/doc_curve.svg")?;
/// Ok(())
/// }
/// ```
///
/// ![doc_curve_vector.svg](https://raw.githubusercontent.com/cpmech/plotpy/main/figures/doc_curve_vector.svg)
///
/// See also integration tests in the [tests directory](https://github.com/cpmech/plotpy/tree/main/tests)
///
/// Output from some integration tests:
///
/// ![integ_curve.svg](https://raw.githubusercontent.com/cpmech/plotpy/main/figures/integ_curve.svg)
///
/// ![integ_curve_3d.svg](https://raw.githubusercontent.com/cpmech/plotpy/main/figures/integ_curve_3d.svg)
pub struct Curve {
label: String, // Name of this curve in the legend
line_alpha: f64, // Opacity of lines (0, 1]. A<1e-14 => A=1.0
line_color: String, // Color of lines
line_style: String, // Style of lines
line_width: f64, // Width of lines
marker_color: String, // Color of markers
marker_every: usize, // Increment of data points to use when drawing markers
marker_void: bool, // Draws a void marker (edge only)
marker_line_color: String, // Edge color of markers
marker_line_width: f64, // Edge width of markers
marker_size: f64, // Size of markers
marker_style: String, // Style of markers, e.g., "`o`", "`+`"
stop_clip: bool, // Stop clipping features within margins
buffer: String, // buffer
}
impl Curve {
/// Creates new Curve object
pub fn new() -> Self {
Curve {
label: String::new(),
line_alpha: 0.0,
line_color: String::new(),
line_style: String::new(),
line_width: 0.0,
marker_color: String::new(),
marker_every: 0,
marker_void: false,
marker_line_color: String::new(),
marker_line_width: 0.0,
marker_size: 0.0,
marker_style: String::new(),
stop_clip: false,
buffer: String::new(),
}
}
/// Begins adding points to the curve (2D only)
///
/// # Warning
///
/// This function must be followed by [Curve::points_add] and [Curve::points_end],
/// otherwise Python/Matplotlib will fail.
pub fn points_begin(&mut self) -> &mut Self {
write!(&mut self.buffer, "xy=np.array([").unwrap();
self
}
/// Adds point to the curve (2D only)
///
/// # Warning
///
/// This function must be called after [Curve::points_begin] and must be followed by [Curve::points_end],
/// otherwise Python/Matplotlib will fail.
pub fn points_add<T>(&mut self, x: T, y: T) -> &mut Self
where
T: std::fmt::Display,
{
write!(&mut self.buffer, "[{},{}],", x, y).unwrap();
self
}
/// Ends adding points to the curve (2D only)
///
/// # Warning
///
/// This function must be called after [Curve::points_begin] and [Curve::points_add],
/// otherwise Python/Matplotlib will fail.
pub fn points_end(&mut self) -> &mut Self {
let opt = self.options();
write!(&mut self.buffer, "])\nplt.plot(xy[:,0],xy[:,1]{})\n", &opt).unwrap();
self
}
/// Begins adding 3D points to the curve
///
/// # Warning
///
/// This function must be followed by [Curve::points_3d_add] and [Curve::points_3d_end],
/// otherwise Python/Matplotlib will fail
pub fn points_3d_begin(&mut self) -> &mut Self {
write!(&mut self.buffer, "xyz=np.array([").unwrap();
self
}
/// Adds 3D point to the curve
///
/// # Warning
///
/// This function must be called after [Curve::points_3d_begin] and must be followed by [Curve::points_3d_end],
/// otherwise Python/Matplotlib will fail.
pub fn points_3d_add<T>(&mut self, x: T, y: T, z: T) -> &mut Self
where
T: std::fmt::Display,
{
write!(&mut self.buffer, "[{},{},{}],", x, y, z).unwrap();
self
}
/// Ends adding 3D points to the curve
///
/// # Warning
///
/// This function must be called after [Curve::points_3d_begin] and [Curve::points_3d_add],
/// otherwise Python/Matplotlib will fail.
pub fn points_3d_end(&mut self) -> &mut Self {
let opt = self.options();
write!(
&mut self.buffer,
"])\nax3d().plot(xyz[:,0],xyz[:,1],xyz[:,2]{})\n",
&opt
)
.unwrap();
self
}
/// Draws curve
///
/// # Input
///
/// * `x` - abscissa values
/// * `y` - ordinate values
///
/// # Notes
///
/// * The type `U` of the input array must be a number.
///
pub fn draw<'a, T, U>(&mut self, x: &'a T, y: &'a T)
where
T: AsVector<'a, U>,
U: 'a + std::fmt::Display,
{
vector_to_array(&mut self.buffer, "x", x);
vector_to_array(&mut self.buffer, "y", y);
let opt = self.options();
write!(&mut self.buffer, "plt.plot(x,y{})\n", &opt).unwrap();
}
/// Draws curve in 3D plot
///
/// # Input
///
/// * `x` - x values
/// * `y` - y values
/// * `z` - z values
///
/// # Notes
///
/// * The type `U` of the input array must be a number.
///
pub fn draw_3d<'a, T, U>(&mut self, x: &'a T, y: &'a T, z: &'a T)
where
T: AsVector<'a, U>,
U: 'a + std::fmt::Display,
{
vector_to_array(&mut self.buffer, "x", x);
vector_to_array(&mut self.buffer, "y", y);
vector_to_array(&mut self.buffer, "z", z);
let opt = self.options();
write!(&mut self.buffer, "ax3d().plot(x,y,z{})\n", &opt).unwrap();
}
/// Sets the name of this curve in the legend
pub fn set_label(&mut self, label: &str) -> &mut Self {
self.label = String::from(label);
self
}
/// Sets the opacity of lines (0, 1]. A<1e-14 => A=1.0
pub fn set_line_alpha(&mut self, alpha: f64) -> &mut Self {
self.line_alpha = alpha;
self
}
/// Sets the color of lines
pub fn set_line_color(&mut self, color: &str) -> &mut Self {
self.line_color = String::from(color);
self
}
/// Draws a ray (an infinite line)
///
/// * For horizontal rays, only `ya` is used
/// * For vertical rays, only `xa` is used
pub fn draw_ray(&mut self, xa: f64, ya: f64, endpoint: RayEndpoint) {
let opt = self.options();
match endpoint {
RayEndpoint::Coords(xb, yb) => write!(
&mut self.buffer,
"plt.axline(({},{}),({},{}){})\n",
xa, ya, xb, yb, &opt
)
.unwrap(),
RayEndpoint::Slope(m) => write!(
&mut self.buffer,
"plt.axline(({},{}),None,slope={}{})\n",
xa, ya, m, &opt
)
.unwrap(),
RayEndpoint::Horizontal => write!(&mut self.buffer, "plt.axhline({}{})\n", ya, &opt).unwrap(),
RayEndpoint::Vertical => write!(&mut self.buffer, "plt.axvline({}{})\n", xa, &opt).unwrap(),
}
}
/// Sets the style of lines
///
/// Options:
///
/// * "`-`", `:`", "`--`", "`-.`", or "`None`"
/// * As defined in <https://matplotlib.org/stable/gallery/lines_bars_and_markers/linestyles.html>
pub fn set_line_style(&mut self, style: &str) -> &mut Self {
self.line_style = String::from(style);
self
}
/// Sets the width of lines
pub fn set_line_width(&mut self, width: f64) -> &mut Self {
self.line_width = width;
self
}
/// Sets the color of markers
pub fn set_marker_color(&mut self, color: &str) -> &mut Self {
self.marker_color = String::from(color);
self
}
/// Sets the increment of data points to use when drawing markers
pub fn set_marker_every(&mut self, every: usize) -> &mut Self {
self.marker_every = every;
self
}
/// Sets the option to draw a void marker (draw edge only)
pub fn set_marker_void(&mut self, flag: bool) -> &mut Self {
self.marker_void = flag;
self
}
/// Sets the edge color of markers
pub fn set_marker_line_color(&mut self, color: &str) -> &mut Self {
self.marker_line_color = String::from(color);
self
}
/// Sets the edge width of markers
pub fn set_marker_line_width(&mut self, width: f64) -> &mut Self {
self.marker_line_width = width;
self
}
/// Sets the size of markers
pub fn set_marker_size(&mut self, size: f64) -> &mut Self {
self.marker_size = size;
self
}
/// Sets the style of markers
///
/// Examples:
///
/// * "`o`", "`+`"
/// * As defined in <https://matplotlib.org/stable/api/markers_api.html>
pub fn set_marker_style(&mut self, style: &str) -> &mut Self {
self.marker_style = String::from(style);
self
}
/// Sets the flag to stop clipping features within margins
pub fn set_stop_clip(&mut self, flag: bool) -> &mut Self {
self.stop_clip = flag;
self
}
/// Returns options for curve
fn options(&self) -> String {
// fix color if marker is void
let line_color = if self.marker_void && self.line_color == "" {
"red"
} else {
&self.line_color
};
// output
let mut opt = String::new();
// label
if self.label != "" {
write!(&mut opt, ",label=r'{}'", self.label).unwrap();
}
// lines
if self.line_alpha > 0.0 {
write!(&mut opt, ",alpha={}", self.line_alpha).unwrap();
}
if line_color != "" {
write!(&mut opt, ",color='{}'", line_color).unwrap();
}
if self.line_style != "" {
write!(&mut opt, ",linestyle='{}'", self.line_style).unwrap();
}
if self.line_width > 0.0 {
write!(&mut opt, ",linewidth={}", self.line_width).unwrap();
}
// markers
if !self.marker_void && self.marker_color != "" {
write!(&mut opt, ",markerfacecolor='{}'", self.marker_color).unwrap();
}
if self.marker_every > 0 {
write!(&mut opt, ",markevery={}", self.marker_every).unwrap();
}
if self.marker_void {
write!(&mut opt, ",markerfacecolor='none'").unwrap();
}
if self.marker_line_color != "" {
write!(&mut opt, ",markeredgecolor='{}'", self.marker_line_color).unwrap();
}
if self.marker_line_width > 0.0 {
write!(&mut opt, ",markeredgewidth={}", self.marker_line_width).unwrap();
}
if self.marker_size > 0.0 {
write!(&mut opt, ",markersize={}", self.marker_size).unwrap();
}
if self.marker_style != "" {
write!(&mut opt, ",marker={}", quote_marker(&self.marker_style)).unwrap();
}
// clipping
if self.stop_clip {
write!(&mut opt, ",clip_on=False").unwrap();
}
opt
}
}
impl GraphMaker for Curve {
fn get_buffer<'a>(&'a self) -> &'a String {
&self.buffer
}
fn clear_buffer(&mut self) {
self.buffer.clear();
}
}
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#[cfg(test)]
mod tests {
use super::{Curve, RayEndpoint};
use crate::GraphMaker;
#[test]
fn new_works() {
let curve = Curve::new();
assert_eq!(curve.label.len(), 0);
assert_eq!(curve.line_alpha, 0.0);
assert_eq!(curve.line_color.len(), 0);
assert_eq!(curve.line_style.len(), 0);
assert_eq!(curve.line_width, 0.0);
assert_eq!(curve.marker_color.len(), 0);
assert_eq!(curve.marker_every, 0);
assert_eq!(curve.marker_void, false);
assert_eq!(curve.marker_line_color.len(), 0);
assert_eq!(curve.marker_line_width, 0.0);
assert_eq!(curve.marker_size, 0.0);
assert_eq!(curve.marker_style.len(), 0);
assert_eq!(curve.buffer.len(), 0);
}
#[test]
fn options_works() {
let mut curve = Curve::new();
curve
.set_label("my-curve")
.set_line_alpha(0.7)
.set_line_color("#b33434")
.set_line_style("-")
.set_line_width(3.0)
.set_marker_color("#4c4deb")
.set_marker_every(2)
.set_marker_void(false)
.set_marker_line_color("blue")
.set_marker_line_width(1.5)
.set_marker_size(8.0)
.set_marker_style("o")
.set_stop_clip(true);
let options = curve.options();
assert_eq!(
options,
",label=r'my-curve'\
,alpha=0.7\
,color='#b33434'\
,linestyle='-'\
,linewidth=3\
,markerfacecolor='#4c4deb'\
,markevery=2\
,markeredgecolor='blue'\
,markeredgewidth=1.5\
,markersize=8\
,marker='o'\
,clip_on=False"
);
let mut curve = Curve::new();
for i in 5..12 {
curve.set_marker_style(&format!("{}", i));
let options = curve.options();
assert_eq!(options, format!(",marker={}", i));
}
}
#[test]
fn points_methods_work() {
let mut curve = Curve::new();
curve.points_begin().points_add(1, 2).points_add(3, 4).points_end();
let b: &str = "xy=np.array([[1,2],[3,4],])\n\
plt.plot(xy[:,0],xy[:,1])\n";
assert_eq!(curve.buffer, b);
}
#[test]
fn points_3d_methods_work() {
let mut curve = Curve::new();
curve
.points_3d_begin()
.points_3d_add(1, 2, 3)
.points_3d_add(4, 5, 6)
.points_3d_end();
let b: &str = "\
xyz=np.array([[1,2,3],[4,5,6],])\n\
ax3d().plot(xyz[:,0],xyz[:,1],xyz[:,2])\n";
assert_eq!(curve.buffer, b);
}
#[test]
fn draw_works() {
let x = &[1.0, 2.0, 3.0, 4.0, 5.0];
let y = &[1.0, 4.0, 9.0, 16.0, 25.0];
let mut curve = Curve::new();
curve.set_label("the-curve");
curve.draw(x, y);
let b: &str = "x=np.array([1,2,3,4,5,],dtype=float)\n\
y=np.array([1,4,9,16,25,],dtype=float)\n\
plt.plot(x,y,label=r'the-curve')\n";
assert_eq!(curve.buffer, b);
curve.clear_buffer();
assert_eq!(curve.buffer, "");
}
#[test]
fn draw_3d_works() {
let x = &[1.0, 2.0, 3.0, 4.0, 5.0];
let y = &[1.0, 4.0, 9.0, 16.0, 25.0];
let z = &[0.0, 0.0, 0.0, 1.0, 1.0];
let mut curve = Curve::new();
curve.set_label("the-curve");
curve.draw_3d(x, y, z);
let b: &str = "x=np.array([1,2,3,4,5,],dtype=float)\n\
y=np.array([1,4,9,16,25,],dtype=float)\n\
z=np.array([0,0,0,1,1,],dtype=float)\n\
ax3d().plot(x,y,z,label=r'the-curve')\n";
assert_eq!(curve.buffer, b);
}
#[test]
fn derive_works() {
let endpoint = RayEndpoint::Coords(8.0, 0.5);
let cloned = endpoint.clone();
assert_eq!(format!("{:?}", endpoint), "Coords(8.0, 0.5)");
assert_eq!(format!("{:?}", cloned), "Coords(8.0, 0.5)");
}
#[test]
fn draw_ray_works() {
let mut ray = Curve::new();
ray.draw_ray(2.0, 0.0, RayEndpoint::Coords(8.0, 0.5));
ray.draw_ray(2.0, 0.0, RayEndpoint::Slope(0.2));
ray.draw_ray(2.0, 0.0, RayEndpoint::Horizontal);
ray.draw_ray(2.0, 0.0, RayEndpoint::Vertical);
let b: &str = "plt.axline((2,0),(8,0.5))\n\
plt.axline((2,0),None,slope=0.2)\n\
plt.axhline(0)\n\
plt.axvline(2)\n";
assert_eq!(ray.buffer, b);
}
}