Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adder api and documentation cleanup #147

Merged
merged 3 commits into from
Dec 27, 2024
Merged

Conversation

desmonddak
Copy link
Contributor

Description & Motivation

Converted all adders to use the same base Adder class with a conditional carry input (Logic? carryIn).

Related Issue(s)

None

Testing

Most adders are now tested uniformly in the adder_test.dart file using both carry and non-carry configurations.

Backwards-compatibility

Is this a breaking change that will not be backwards-compatible? If yes, how so?

Yes. The FullAdder no longer has a carryOut, it is in sum[1]. Otherwise, other adders now have an optional carryIn.

Documentation

Does the change require any updates to documentation? If so, where? Are they included?

Yes. All adder documentation has been updated to reflect the change.

@desmonddak desmonddak requested a review from mkorbel1 December 24, 2024 06:07
Copy link
Contributor

@mkorbel1 mkorbel1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thank you!

Just a few minor things

doc/README.md Outdated Show resolved Hide resolved
doc/components/adder.md Outdated Show resolved Hide resolved
doc/components/adder.md Outdated Show resolved Hide resolved
@desmonddak desmonddak requested a review from mkorbel1 December 27, 2024 00:43
Copy link
Contributor

@mkorbel1 mkorbel1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

@desmonddak desmonddak merged commit f3fbb8b into intel:main Dec 27, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants