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
///////////////////////////////////////////////////////////////////////////////////////////////////
// List Node macros
///////////////////////////////////////////////////////////////////////////////////////////////////
/// ## Description
///
/// A macro to reduce the boilerplate in generating a full ListNode.
///
/// ## 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
///////////////////////////////////////////////////////////////////////////////////////////////////
/// TODO:
/// You can generate TreeNodes manually by utilizing tuples. The first value is a single value and
/// everything else is a tuple of `(Option<i32>, Option<i32>)`
// #[macro_export]
#[allow(unused_macros)]
macro_rules! tree {
($val:expr) => {
$crate::utils::TreeNode::new($val)
};
($($left:tt, $right:tt)*) => {
$(
if let Some(left) = $left {
$node.left = Some(std::rc::Rc::new(std::cell::RefCell::new(tree!(
left
))));
}
if let Some(right) = $right {
$node.right = Some(std::rc::Rc::new(std::cell::RefCell::new(tree!(
right
))));
}
)*
};
($val:expr, $($left:expr, $right:expr)*) => {
{
let mut node = $crate::utils::TreeNode::new($val);
$(
tree!(node, ($left, $right));
)*
node
}
};
}
/// ## 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));
/// ```
/// Now you have a tree that branches all the way through the right side without having anything on
/// the left.
#[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
}};
}