fix wrong carry bit output

Added carry return (VERY NOT SURE IF IT WORKS CORRECTLY).

Cargo.toml

@@ -1,16 +0,0 @@
-[package]
-name = "rust_tests"
-version = "0.1.0"
-edition = "2021"
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
-[profile.release]
-opt-level = 'z'     # Optimize for size
-lto = true          # Enable link-time optimization
-codegen-units = 1   # Reduce number of codegen units to increase optimizations
-panic = 'abort'     # Abort on panic
-strip = true        # Strip symbols from binary*
-
-[dependencies]
-text_io = "0.1.12"

README.md

@@ -0,0 +1,3 @@
+# binaryCalculatorPrototype
+
+This is a Python language prototype for a binary calculator to be used in Computer Arithmetics lab works for first-year students studying Computer Engineering at KPI.

bitutilities.py

@@ -0,0 +1,109 @@
+from collections import deque
+from typing_extensions import Self
+
+
+class BasicRegister:
+    """
+    The BasicRegister represents a hardware register capable of manipulating multiple bits at a time.
+
+    :param deque[bool] memory: The bits stored inside the register.
+    """
+
+    def __init__(self, memory: list[bool]):
+        self.memory: deque[bool] = deque(memory)
+
+    def __repr__(self) -> str:
+        return f"Memory: {[int(value) for value in  self.memory]}"
+
+    def __str__(self) -> str:
+        return f"Memory: {[int(value) for value in  self.memory]}"
+
+    def __len__(self) -> int:
+        return len(self.memory)
+
+    def adjusted_by_size(self, resulting_size: int) -> Self:
+        """
+        Adjusts a register to a given size.
+
+        :param int resulting_size: The size of the resulting register.
+
+        :return: A register of a specified size.
+        :rtype: BasicRegister
+        """
+        current_memory_size: int = len(self.memory)
+        return BasicRegister(
+            [False] * max(resulting_size - current_memory_size, 0) + list(self.memory)[-resulting_size:]
+        )
+
+    def reverse(self):
+        self.memory = deque([not value for value in self.memory])
+
+    def left_shift(self, digit_to_fill: bool = False, steps_shifted: int = 1) -> deque[bool]:
+        self.memory.extend([digit_to_fill] * steps_shifted)
+        shifted_radices: deque[bool] = deque([self.memory.popleft() for _i in range(steps_shifted)])
+        return shifted_radices
+
+    def right_shift(self, digit_to_fill: bool = False, steps_shifted: int = 1) -> deque[bool]:
+        self.memory.extendleft([digit_to_fill] * steps_shifted)
+        shifted_radices: deque[bool] = deque([self.memory.pop() for _i in range(steps_shifted)])
+        return shifted_radices
+
+
+def get_memory(variable_name: str) -> list[bool]:
+    """
+    Reads user input to be used as a memory array.
+
+    :param str variable_name: The name to be displayed in the input line.
+
+    :return: A list of boolean values read from user.
+    :rtype: list[bool]
+    """
+    while True:
+        input_chars: list[str] = list(input(f"Enter {variable_name}: "))
+
+        if all(character in ["0", "1"] for character in input_chars):
+            return [True if character == "1" else False for character in input_chars]
+        else:
+            print(f"[ERROR] The {variable_name} may contain only 1-s and 0-s!")
+
+
+def binary_sum(first_term: BasicRegister, second_term: BasicRegister, return_remainder: bool = False)\
+        -> BasicRegister | tuple[BasicRegister, int]:
+    """
+    Sums two registers' values.
+
+    :param BasicRegister first_term: First register.
+    :param BasicRegister second_term: Second register.
+    :param bool return_remainder: True to return the tuple, False to return just the register.
+
+    :return: Register containing the sum or the tuple containing the register and carried radix.
+    :rtype: BasicRegister | tuple[BasicRegister, int]
+    """
+    size_a = len(first_term)
+    size_b = len(second_term)
+
+    required_size = max(size_a, size_b)
+
+    a = first_term
+    b = second_term
+
+    if size_a != size_b:
+        a = a.adjusted_by_size(required_size)
+        b = b.adjusted_by_size(required_size)
+
+    c = BasicRegister([False] * required_size)
+
+    carry = False
+    for i in range(required_size - 1, 0, -1):
+        current_bit_sum = a.memory[i] + b.memory[i] + carry
+        carry = bool(current_bit_sum & 2)
+        c.memory[i] = bool(current_bit_sum & 1)
+
+    final_bit_sum = a.memory[0] + b.memory[0] + carry
+    carry = bool(final_bit_sum & 2)
+    c.memory[0] = bool(final_bit_sum & 1)
+
+    if return_remainder:
+        return c, carry
+    else:
+        return c

main.py

@@ -0,0 +1,31 @@
+import bitutilities as bu
+import timeit
+
+
+if __name__ == '__main__':
+    reg: bu.BasicRegister = bu.BasicRegister(bu.get_memory("memory"))
+
+    print()
+    print("Register 1:")
+    print(reg)
+
+    print()
+    reg2: bu.BasicRegister = bu.BasicRegister(bu.get_memory("more memory"))
+
+    print()
+    print("Register 2:")
+    print(reg2)
+
+    print()
+    reg3: bu.BasicRegister = bu.binary_sum(reg, reg2)
+
+    print()
+    print("Sum:")
+    print(reg3)
+
+    carry_sum_test: tuple[bu.BasicRegister, int] = bu.binary_sum(reg, reg2, True)
+
+    print()
+    print("Sum & carry:")
+    # print(type(carry_sum_test))
+    print(carry_sum_test)

src/bit_utilities.rs

@@ -1,101 +0,0 @@
-use std::fmt;
-use std::fmt::Formatter;
-
-fn capitalise(s: &str) -> String {
-    let mut c = s.chars();
-    match c.next() {
-        None => String::new(),
-        Some(f) => f.to_uppercase().collect::<String>() + c.as_str(),
-    }
-}
-
-/// A basic register capable of storing binary data.
-#[derive(Debug)]
-pub struct BasicRegister {
-    /// A [Vec] that stores the binary data of the register.
-    memory: Vec<bool>,
-}
-
-impl BasicRegister {
-    pub fn l_shift(&mut self) {
-        let mut res: Vec<bool> = vec![false; self.memory.len()];
-
-        res[..(self.memory.len() - 1)]
-            .copy_from_slice(&self.memory[1..((self.memory.len() - 1) + 1)]);
-
-        self.memory = res;
-    }
-
-    pub fn r_shift(&mut self) {
-        let mut res: Vec<bool> = vec![false; self.memory.len()];
-
-        for i in (1..self.memory.len()).rev() {
-            res[i] = self.memory[i - 1];
-        }
-
-        self.memory = res;
-    }
-
-    pub fn reverse(&mut self) {
-        self.memory = self.memory.iter().map(|val| !val).collect();
-    }
-
-    pub fn new(memory: Vec<bool>) -> Self {
-        Self { memory }
-    }
-}
-
-impl Default for BasicRegister {
-    fn default() -> Self {
-        Self {
-            memory: vec![false],
-        }
-    }
-}
-
-impl fmt::Display for BasicRegister {
-    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
-        write!(f, "Memory: [")?;
-
-        for (count, v) in self.memory.iter().enumerate() {
-            if count != 0 {
-                write!(f, ", ")?;
-            }
-            write!(f, "{}", *v as u8)?;
-        }
-
-        write!(f, "]")
-    }
-}
-
-fn read_vec(variable_name: &str) -> Vec<char> {
-    loop {
-        print!("Enter {variable_name}: ");
-        let input: String = text_io::read!("{}\n");
-        match input.chars().all(|c| c == '1' || c == '0') {
-            true => return input.chars().collect(),
-            false => eprintln!(
-                "[ERROR] {} may contain only 1-s and 0-s with no whitespaces!",
-                capitalise(variable_name)
-            ),
-        }
-    }
-}
-
-pub fn char_to_bool_vector(char_vector: Vec<char>) -> Vec<bool> {
-    let mut bool_vector: Vec<bool> = Vec::new();
-
-    for value in char_vector.iter() {
-        match value {
-            '0' => bool_vector.push(false),
-            '1' => bool_vector.push(true),
-            _ => (),
-        }
-    }
-
-    bool_vector
-}
-
-pub fn get_memory(variable_name: &str) -> Vec<bool> {
-    char_to_bool_vector(read_vec(variable_name))
-}

src/main.rs

@@ -1,44 +0,0 @@
-#[allow(dead_code)]
-mod bit_utilities;
-
-use bit_utilities::*;
-// use text_io::read;
-
-fn main() {
-       let mut reg = BasicRegister::new(get_memory("your number"));
-    // let mut reg: BasicRegister = Default::default();
-
-    println!("\nRegister:");
-    println!("{}", reg);
-
-    println!("\nShifted right:");
-    reg.r_shift();
-    println!("{}", reg);
-
-    println!("\nShifted left:");
-    reg.l_shift();
-    println!("{}", reg);
-
-    println!("\nReversed:");
-    reg.reverse();
-    println!("{}", reg);
-
-    // println!("{}", true);
-    // println!("{}", true);
-
-    // let a: i8 = read!();
-    // println!("{} {0:b}", a);
-    // println!("{} {0:b}", a >> 1);
-    // println!("{} {0:b}", a << 1);
-    // println!("{} {0:b}", !a);
-    // println!("{}", '3'.to_digit(2).unwrap());
-    // let f_text = format!("{a:b}").chars().collect::<Vec<char>>();
-    // println!("{:?}", f_text);
-    // println!("{:?}", char_to_bool_vector(f_text.clone()));
-    // let b: BasicRegister = BasicRegister::new(char_to_bool_vector(f_text));
-    // b.print_register();
-    // println!("{:?}", get_memory(format!("{a:b}")));
-    // println!("{:?}", a.split(" ").collect::<Vec<&str>>());
-    // a = text_io::read!("{}\n");
-    // println!("{a}")
-}