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
/// Iternal macro helper functions.
#[doc(hidden)]
pub mod helper_functions;
///////////////////////////////////////////////////////////////////////////////////////////////////
// List Node macros
///////////////////////////////////////////////////////////////////////////////////////////////////
/// ## Description
///
/// A macro to reduce the boilerplate in generating a full ListNode.
///
/// ## Match arms
///
/// Arm 1:
/// - Takes the value as an argument.
/// - Equivalent of doing `ListNode::new()`.
///
/// Arm 2:
/// - Takes the value as an argument.
/// - Also takes a sequence of left and right node values at the same time (which means they're
/// symmetric) as an argument (and builds the `ListNode` struct with them).
///
/// ## Example
///
/// This code:
///
/// ```rust
/// use leetcode_trees_rs::utils::list_node;
///
/// let node = list_node!(1, 2, 3, 4);
/// ```
///
/// Is the equivalent of the following:
///
/// ```rust
/// use std::boxed::Box;
/// use leetcode_trees_rs::utils::{list_node, ListNode};
///
/// let node = ListNode {
/// val: 1,
/// next: Some(Box::new(ListNode {
/// val: 2,
/// next: Some(Box::new(ListNode {
/// val: 3,
/// next: Some(Box::new(ListNode::new(4))),
/// }))
/// }))
/// };
/// assert_eq!(node, list_node!(1, 2, 3, 4));
/// ```
#[macro_export]
macro_rules! list_node {
($val:expr) => {
$crate::utils::ListNode::new($val)
};
($val:expr, $($rest:tt)*) => {
{
let mut node = $crate::utils::ListNode::new($val);
node.next = Some(std::boxed::Box::new(list_node!($($rest)*)));
node
}
};
}
///////////////////////////////////////////////////////////////////////////////////////////////////
// Tree Node macros
///////////////////////////////////////////////////////////////////////////////////////////////////
/// ## Description
///
/// You can generate TreeNodes manually by utilizing a `[Vec<Option<i32>]` data structure.
///
/// **IMPORTANT:** Whenever you have more Nodes and there's a None node above - It's up to you to
/// make sure that the nodes are matched correctly. Whenever there's a `None` value at a level
/// that's not the last one then the next level will ignore every impossible value. This means that
/// if you want this tree:
///
/// ```markdown
/// Some(100) // Root Node
/// / \
/// None Some(21) // Left and Right nodes respectively
/// / \
/// None None
/// ```
///
/// You need to call the macro like this:
///
/// ```rust
/// use std::{rc::Rc, cell::RefCell};
/// use leetcode_trees_rs::utils::{tree, TreeNode};
///
/// let tree = tree!(
/// &[
/// vec![Some(100)],
/// vec![None, Some(21)],
/// vec![Some(11), None], // **DON'T** use 4 `Option` values! The first two are inferred!
/// ]
/// );
///
/// assert_eq!(
/// tree,
/// Some(Rc::new(RefCell::new(TreeNode {
/// val: 100,
/// left: None,
/// right: Some(Rc::new(RefCell::new(TreeNode {
/// val: 21,
/// left: Some(Rc::new(RefCell::new(TreeNode::new(11)))),
/// right: None
/// })))
/// })))
/// );
/// ```
///
/// Another important note: If the `None` value is a the end of a vec like this:
///
/// ```rust
/// use std::{rc::Rc, cell::RefCell};
/// use leetcode_trees_rs::utils::{tree, TreeNode};
///
/// let tree = tree!(
/// &[
/// vec![Some(100)],
/// vec![Some(21), None], // ! You need to have that trialing None !
/// vec![Some(11)], // Otherwise this `11` will get written to root->right rather
/// // than of root->left->left.
/// ]
/// );
///
/// assert_eq!(
/// tree,
/// Some(Rc::new(RefCell::new(TreeNode {
/// val: 100,
/// left: Some(Rc::new(RefCell::new(TreeNode {
/// val: 21,
/// left: Some(Rc::new(RefCell::new(TreeNode::new(11)))),
/// right: None
/// }))),
/// right: None
/// })))
/// );
/// ```
///
/// ## Match arms
///
/// Arm 1:
/// - Takes the `[Vec<Option<i32>>]` data type which contains the `TreeNode` values based on the
/// description for this macro.
///
///
/// ## Additional examples
///
/// Making a tree only towards the left side:
///
/// ```rust
/// use std::{cell::RefCell, rc::Rc};
/// use leetcode_trees_rs::utils::{tree, symmetric_tree, TreeNode};
///
/// let node_left_sided = TreeNode {
/// val: 1,
/// left: Some(Rc::new(RefCell::new(TreeNode {
/// val: 2,
/// left: Some(Rc::new(RefCell::new(TreeNode::new(5)))),
/// right: Some(Rc::new(RefCell::new(TreeNode::new(6)))),
/// }))),
/// right: None,
/// };
/// assert_eq!(
/// Rc::new(RefCell::new(node_left_sided)),
/// tree!(
/// &[
/// vec![Some(1)],
/// vec![Some(2), None], // (!) You need to specify any trailing `None` values.
/// vec![Some(5), Some(6), /* None, None */],
/// ]
/// ).expect("Failed to generate TreeNode from [Vec<i32>]")
/// );
/// ```
///
/// Making a tree only towards the right side:
///
/// ```rust
/// use std::{cell::RefCell, rc::Rc};
/// use leetcode_trees_rs::utils::{tree, symmetric_tree, TreeNode};
///
/// let node_right_sided = TreeNode {
/// val: 1,
/// left: None,
/// right: Some(Rc::new(RefCell::new(TreeNode {
/// val: 3,
/// left: Some(Rc::new(RefCell::new(TreeNode::new(7)))),
/// right: Some(Rc::new(RefCell::new(TreeNode::new(8)))),
/// }))),
/// };
/// assert_eq!(
/// Rc::new(RefCell::new(node_right_sided)),
/// tree!(
/// &[
/// vec![Some(1)],
/// vec![None, Some(3)],
/// // The other `None` values are inferred from their parents.
/// //
/// // **IMPORTANT:** Don't add them in because it causes errors!
/// vec![/*None, None, */ Some(7), Some(8)],
/// ]
/// ).expect("Failed to generate TreeNode from [Vec<i32>]")
/// );
/// ```
///
/// Utilizig both sides in making a tree:
///
/// ```rust
/// use std::{cell::RefCell, rc::Rc};
/// use leetcode_trees_rs::utils::{tree, symmetric_tree, TreeNode};
///
/// let node_both_sided = TreeNode {
/// val: 1,
/// left: Some(Rc::new(RefCell::new(TreeNode {
/// val: 2,
/// left: Some(Rc::new(RefCell::new(TreeNode::new(5)))),
/// right: Some(Rc::new(RefCell::new(TreeNode::new(6)))),
/// }))),
/// right: Some(Rc::new(RefCell::new(TreeNode {
/// val: 3,
/// left: Some(Rc::new(RefCell::new(TreeNode::new(7)))),
/// right: Some(Rc::new(RefCell::new(TreeNode::new(8)))),
/// }))),
/// };
/// assert_eq!(
/// Rc::new(RefCell::new(node_both_sided)),
/// tree!(
/// &[
/// vec![Some(1)],
/// vec![Some(2), Some(3)],
/// vec![Some(5), Some(6), Some(7), Some(8)],
/// ]
/// ).expect("Failed to generate TreeNode from [Vec<i32>]")
/// );
/// ```
///
/// ## Performance
///
/// The way this is implemented is with depth traversal (similiar to [Breath-First
/// Search](https://en.wikipedia.org/wiki/Breadth-first_search)) so the algorithm's performance is:
///
/// Worst-case time complexity: O(|V| + |E|) = O(b<sup>d</sup>)
///
/// Worst-case space complexity: O(|V|) = O(b<sup>d</sup>)
///
/// Where:
///
/// V = Verticies and E = Edges
#[macro_export]
macro_rules! tree {
($items:expr) => {{
$crate::macros::helper_functions::_build_tree($items)
}};
}
/// ## Description
///
/// A macro to reduce the boilerplate in generating symmetric binary trees.
///
/// ## Match arms
///
/// Arm 1:
/// - Takes the value as an argument.
/// - Equivalent of doing `TreeNode::new()`.
///
/// Arm 2:
/// - Takes the value as an argument.
/// - Also takes a sequence of left and right node values at the same time (which means they're
/// symmetric) as an argument (and builds the `TreeNode` struct with them).
///
/// ## Example usage
///
/// ```rust
/// use leetcode_trees_rs::utils::symmetric_tree;
/// symmetric_tree!(1, 2, 3, 4);
/// ```
/// The symmetric_tree! macro invocation is desugared to this:
/// ```rust
/// use std::{rc::Rc, cell::RefCell, boxed::Box};
///
/// use leetcode_trees_rs::utils::{symmetric_tree, TreeNode};
///
/// let node = TreeNode {
/// val: 1,
/// left: Some(Rc::new(RefCell::new(TreeNode{
/// val: 2,
/// left: Some(Rc::new(RefCell::new(TreeNode{
/// val: 3,
/// left: Some(Rc::new(RefCell::new(TreeNode{
/// val: 4,
/// left: None,
/// right: None,
/// }))),
/// right: Some(Rc::new(RefCell::new(TreeNode{
/// val: 4,
/// left: None,
/// right: None,
/// }))),
/// }))),
/// right: Some(Rc::new(RefCell::new(TreeNode{
/// val: 3,
/// left: Some(Rc::new(RefCell::new(TreeNode{
/// val: 4,
/// left: None,
/// right: None,
/// }))),
/// right: Some(Rc::new(RefCell::new(TreeNode{
/// val: 4,
/// left: None,
/// right: None,
/// }))),
/// }))),
/// }))),
/// right: Some(Rc::new(RefCell::new(TreeNode{
/// val: 2,
/// left: Some(Rc::new(RefCell::new(TreeNode{
/// val: 3,
/// left: Some(Rc::new(RefCell::new(TreeNode{
/// val: 4,
/// left: None,
/// right: None,
/// }))),
/// right: Some(Rc::new(RefCell::new(TreeNode{
/// val: 4,
/// left: None,
/// right: None,
/// }))),
/// }))),
/// right: Some(Rc::new(RefCell::new(TreeNode{
/// val: 3,
/// left: Some(Rc::new(RefCell::new(TreeNode{
/// val: 4,
/// left: None,
/// right: None,
/// }))),
/// right: Some(Rc::new(RefCell::new(TreeNode{
/// val: 4,
/// left: None,
/// right: None,
/// }))),
/// }))),
/// }))),
/// };
/// assert_eq!(node, symmetric_tree!(1, 2, 3, 4));
/// ```
///
/// Another way of desugaring this symmetric tree is with the tree!() macro like so:
///
/// ```rust
/// use std::{rc::Rc, cell::RefCell};
/// use leetcode_trees_rs::utils::{symmetric_tree, tree};
/// assert_eq!(
/// tree!(
/// &mut [
/// vec![Some(1)],
/// vec![Some(2), Some(2)],
/// vec![Some(3), Some(3), Some(3), Some(3)],
/// vec![Some(4), Some(4), Some(4), Some(4), Some(4), Some(4), Some(4), Some(4)],
/// ]
/// ).unwrap(),
/// Rc::new(RefCell::new(symmetric_tree!(1, 2, 3, 4))));
/// ```
#[macro_export]
macro_rules! symmetric_tree {
($val:expr) => {
$crate::utils::TreeNode::new($val)
};
($val:expr, $($both_sides:tt)*) => {
{
let mut node = $crate::utils::TreeNode::new($val);
node.left = Some(std::rc::Rc::new(std::cell::RefCell::new(symmetric_tree!(
$($both_sides)*
))));
node.right = Some(std::rc::Rc::new(std::cell::RefCell::new(symmetric_tree!(
$($both_sides)*
))));
node
}
};
}
/// ## Description
///
/// A macro to reduce the boilerplate in generating left-sided only binary trees.
///
/// ## Match arms
///
/// Arm 1:
/// - Takes the value as an argument.
/// - Equivalent of doing `TreeNode::new()`.
///
/// Arm 2:
/// - Takes the value as an argument.
/// - Also takes a sequence of left only node values as an argument (and builds the `TreeNode`
/// struct with them).
///
/// ## Example
///
/// This code:
///
/// ```rust
/// use leetcode_trees_rs::utils::left_tree;
///
/// let left_only_tree = left_tree!(1, 2, 3);
/// ```
///
/// Is equivalent to this:
///
/// ```rust
/// use std::{rc::Rc, cell::RefCell};
/// use leetcode_trees_rs::utils::{left_tree, TreeNode};
///
/// let left_only_tree = TreeNode {
/// val: 1,
/// left: Some(Rc::new(RefCell::new(TreeNode {
/// val: 2,
/// left: Some(Rc::new(RefCell::new(TreeNode {
/// val: 3,
/// left: None,
/// right: None,
/// }))),
/// right: None,
/// }))),
/// right: None,
/// };
/// assert_eq!(left_only_tree, left_tree!(1, 2, 3));
/// ```
#[macro_export]
macro_rules! left_tree {
($val:expr) => {
$crate::utils::TreeNode::new($val)
};
($val:expr, $($left:tt)*) => {{
let mut node = $crate::utils::TreeNode::new($val);
node.left = Some(std::rc::Rc::new(std::cell::RefCell::new(left_tree!($($left)*))));
node
}};
}
/// ## Description
///
/// A macro to reduce the boilerplate in generating right-sided only binary trees.
///
/// ## Match arms
///
/// Arm 1:
/// - Takes the value as an argument.
/// - Equivalent of doing `TreeNode::new()`.
///
/// Arm 2:
/// - Takes the value as an argument.
/// - Also takes a sequence of right only node values as an argument (and builds the `TreeNode`
/// struct with them).
///
/// ## Example
///
/// This code:
///
/// ```rust
/// use leetcode_trees_rs::utils::right_tree;
///
/// let right_only_tree = right_tree!(1, 2, 3);
/// ```
///
/// Is equivalent to this:
///
/// ```rust
/// use std::{rc::Rc, cell::RefCell};
/// use leetcode_trees_rs::utils::{right_tree, TreeNode};
///
/// let right_only_tree = TreeNode {
/// val: 1,
/// left: None,
/// right: Some(Rc::new(RefCell::new(TreeNode {
/// val: 2,
/// left: None,
/// right: Some(Rc::new(RefCell::new(TreeNode {
/// val: 3,
/// left: None,
/// right: None,
/// })))
/// })))
/// };
/// assert_eq!(right_only_tree, right_tree!(1, 2, 3));
/// ```
#[macro_export]
macro_rules! right_tree {
($val:expr) => {
$crate::utils::TreeNode::new($val)
};
($val:expr, $($right:tt)*) => {{
let mut node = $crate::utils::TreeNode::new($val);
node.right = Some(std::rc::Rc::new(std::cell::RefCell::new(right_tree!(
$($right)*
))));
node
}};
}