📗 Push Swap

A simple sorting algorithm that sorts stacks in ascending order.

Coded in  

Table Of Contents

• Features
• Rules
• Installation
• Examples
• Tools
• License

Features

Disclaimer: While my implementation of push_swap is functional, it will not achieve 100% for the project

• Sorting Capability: The program is capable of sorting stacks in ascending order.
• Scalability: It can handle an unlimited number of inputs, making it adaptable to various use cases and data sizes. However it does become slower/more inefficent with more numbers.
• Error Handling: The program is designed to manage errors and incorrect inputs effectively. It also frees up resources accordingly to prevent memory leaks.
• Memory Management: The program is careful in its memory management, ensuring that all allocated memory is correctly freed, thereby preventing any potential memory leaks.
• Documentation: All functions are thoroughly documented using Doxygen comments. Additionally, the code is supplemented with comments to enhance readability and facilitate easier understanding of the underlying logic.

Rules

1. You have 2 stacks named a and b.
   • At the beginning:
     • The stack a contains a random amount of negative and/or positive numbers which cannot be duplicated.
     • The stack b is empty.
2. The following operations at your disposal:

Operation	Description
sa (swap a)	Swap the first 2 elements at the top of stack a. Does nothing if there is only one or no elements.
sb (swap b)	Swap the first 2 elements at the top of stack b. Does nothing if there is only one or no elements.
ss	Executes sa and sb at the same time.
pa (push a)	Takes the first element at the top of stack b and puts it at the top of stack a. Does nothing if stack b is empty.
pb (push b)	Takes the first element at the top of stack a and puts it at the top of stack b. Does nothing if stack a is empty.
ra (rotate a)	Shifts up all elements of stack a by 1. The first element becomes the last one.
rb (rotate b)	Shifts up all elements of stack b by 1. The first element becomes the last one.
rr	Executes ra and rb at the same time.
rra (reverse rotate a)	Shifts down all elements of stack a by 1. The last element becomes the first one.
rrb (reverse rotate b)	Shifts down all elements of stack b by 1. The last element becomes the first one.
rrr	Executes rra and rrb at the same time.

Installation

1. Clone the repository:

git clone https://github.com/RealConrad/42push-swap.git

2. Enter the directory:

cd 42push-swap

3. Build the library

NOTE: This will clone the following repository (https://github.com/RealConrad/42c-library.git)

make

Examples

Once you build the library, it will generate a push_swap executable file.
You can use it like so: ./push_swap <random numbers> or ./push_swap "<random numbers>".

Valid Input Examples:

3 Numbers:

./push_swap 3 1 2

5 Numbers:

./push_swap 5 1 4 2 3

100 Numbers:

./push_swap 84 29 56 37 61 9 45 79 92 51 6 24 2 68 83 70 47 96 16 74 64 39 55 13 1 90 5 58 76 28 88 31 72 87 94 20 77 40 97 63 19 23 80 44 12 81 60 95 69 66 25 85 21 98 53 78 30 10 18 49 71 41 3 86 14 75 38 91 34 26 62 11 99 7 22 42 50 67 32 48 15 89 36 59 27 8 43 65 54 33 93 4 17 73 46 57 35 82 52 100

Invalid Input Examples

Non-Numeric Values:

./push_swap three one two

Alpha-numeric Values:

./push_swap 1 3dh 75 21 9 gh

Values Greater/Less than MAXINT/MININT:

./push_swap -3274823478 2356234782686 2346736221

Tools

To better visualize and test push_swap, consider using the following tool:

• Push Swap Visualizer: This tool provides a visual representation of the push_swap operations.

License

MIT