diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,13 @@ +# Changelog for `symtegration` + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to the +[Haskell Package Versioning Policy](https://pvp.haskell.org/). + +## Unreleased + +## 0.1.0 - 2025-02-01 + +* Initial release. diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,62 @@ +# Symtegration in IHaskell + +IHaskell extension for making the use of [Symtegration] more seamless with [IHaskell]. + +[Symtegration]: https://symtegration.dev/ + +[IHaskell]: https://github.com/IHaskell/IHaskell + +For example, the integral from the following will be rendered as a mathematical expression. + +![Example of integral rendered by IHaskell](docs/integration-example.png) + +[![Build](https://github.com/symtegration/ihaskell/actions/workflows/build.yaml/badge.svg)](https://github.com/symtegration/ihaskell/actions/workflows/build.yaml) +[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/symtegration/ihaskell/badge)](https://scorecard.dev/viewer/?uri=github.com/symtegration/ihaskell) + +## Installation + +To use with a local IHaskell installation, include extra dependencies in `stack.yaml`. +For example, + +```yaml +extra-deps: +- symtegration-0.6.1 +- ihaskell-symtegration-0.1.0 +``` + +Once the extra dependencies are built and installed, +they should be available for use within IHaskell. + +```bash +$ stack install symtegration ihaskell-symtegration +``` + +## Changes + +See [`CHANGELOG.md`] for what has changed. + +[`CHANGELOG.md`]: CHANGELOG.md + +## Code of conduct + +Be nice; see [`CODE_OF_CONDUCT.md`] for details. + +[`CODE_OF_CONDUCT.md`]: docs/CODE_OF_CONDUCT.md + +## Security policy + +See [`SECURITY.md`] for details. + +[`SECURITY.md`]: docs/SECURITY.md + +## Contributing + +See [`CONTRIBUTING.md`] for details. + +[`CONTRIBUTING.md`]: docs/CONTRIBUTING.md + +## License + +Apache 2.0; see [`LICENSE`] for details. + +[`LICENSE`]: LICENSE diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md new file mode 100644 --- /dev/null +++ b/docs/CODE_OF_CONDUCT.md @@ -0,0 +1,127 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at dev@chungyc.org. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,75 @@ +# How to contribute + +## Before you begin + +### Review community guidelines + +This project follows the [Contributor Covenant Code of Conduct]. + +[Contributor Covenant Code of Conduct]: CODE_OF_CONDUCT.md + +### Review license + +Any contributions are to be licensed under the [Apache-2.0 license]. +Review the license to determine whether you are willing to license +any contributions under the same license. + +[Apache-2.0 license]: ../LICENSE + +## Contribution process + +### Code reviews + +All external contributions require review. +[GitHub pull requests] are used for this purpose. + +[GitHub pull requests]: https://docs.github.com/en/pull-requests + +### Coding standards + +User-visible entities should be documented with [Haddock], including examples if feasible. +[HLint] should report no issues, and formatting should be according to [Ormolu]. + +[Haddock]: https://haskell-haddock.readthedocs.io/ +[HLint]: https://github.com/ndmitchell/hlint +[Ormolu]: https://github.com/tweag/ormolu + +All changes should be accompanied by corresponding tests. +This project uses [Hspec] for testing. + +[Hspec]: https://hspec.github.io/ + +All warnings are enabled for builds. +If a certain warning is unavoidable, it should only be disabled on a per file basis. +While the warnings are not errors by default, code with compiler warnings will not +be merged, and the continuous build upgrades these to errors. +To upgrade compiler warnings to errors locally, use the `--pedantic` flag. + +```bash +$ stack build --pedantic +$ stack test --pedantic +``` + +### Releases + +When releasing, these files should be updated: + +* [`CHANGELOG.md`] with user-visible changes. + +* [`package.yaml`] with the new version. There should be at least one + subsequent `stack build` to update [`ihaskell-symtegration.cabal`] as well. + +Versioning is based on [semantic versioning] and the [Haskell package versioning policy]. +When there are differences between the two policies, the latter takes precedence. + +Lower version bounds for dependencies should be verified by setting the versions +to the lowest minor versions in the Cabal configuration and checking that +builds and tests are still successful. These changes to the Cabal configuration +are only for confirming that the lower bounds are still valid, and should not +be submitted to the repository. + +[`CHANGELOG.md`]: ../CHANGELOG.md +[`package.yaml`]: ../package.yaml +[`ihaskell-symtegration.cabal`]: ../ihaskell-symtegration.cabal +[semantic versioning]: https://semver.org/ +[Haskell package versioning policy]: https://pvp.haskell.org/ diff --git a/docs/SECURITY.md b/docs/SECURITY.md new file mode 100644 --- /dev/null +++ b/docs/SECURITY.md @@ -0,0 +1,10 @@ +# Security Policy + +## Reporting a vulnerability + +To report a security bug, submit details such as what the vulnerability is, +what risks it may entail, and how to reproduce it [via GitHub]. +I will try to respond and deal with the issue within 2 weeks. +Disclosure policy is to disclose a vulnerability within 90 days of it being reported. + +[via GitHub]: https://github.com/symtegration/ihaskell/security/advisories/new diff --git a/docs/integration-example.png b/docs/integration-example.png new file mode 100644 Binary files /dev/null and b/docs/integration-example.png differ diff --git a/ihaskell-symtegration.cabal b/ihaskell-symtegration.cabal new file mode 100644 --- /dev/null +++ b/ihaskell-symtegration.cabal @@ -0,0 +1,74 @@ +cabal-version: 1.18 + +-- This file has been generated from package.yaml by hpack version 0.37.0. +-- +-- see: https://github.com/sol/hpack + +name: ihaskell-symtegration +version: 0.1.0 +synopsis: IHaskell extension for making the use of Symtegration more seamless. +description: IHaskell extension for making the use of Symtegration more seamless. + See the [README](https://github.com/symtegration/ihaskell) on GitHub for more information. +category: Development, Symbolic Computation +homepage: https://symtegration.dev/ +bug-reports: https://github.com/symtegration/ihaskell/issues +author: Yoo Chung +maintainer: dev@chungyc.org +copyright: Copyright 2025 Yoo Chung +license: Apache-2.0 +license-file: LICENSE +build-type: Simple +tested-with: + GHC == 9.8.4 || == 9.6.6 || == 9.6.4 +extra-source-files: + LICENSE + README.md +extra-doc-files: + CHANGELOG.md + docs/CODE_OF_CONDUCT.md + docs/CONTRIBUTING.md + docs/integration-example.png + docs/SECURITY.md + +source-repository head + type: git + location: https://github.com/symtegration/ihaskell + +library + exposed-modules: + IHaskell.Display.Symtegration + other-modules: + Paths_ihaskell_symtegration + hs-source-dirs: + src + default-extensions: + OverloadedStrings + ghc-options: -Wall + build-depends: + base >=4.9 && <4.22 + , ihaskell >=0.11 && <0.13 + , symtegration ==0.6.* + , text >=1 && <3 + default-language: GHC2021 + +test-suite spec + type: exitcode-stdio-1.0 + main-is: Spec.hs + other-modules: + IHaskell.Display.SymtegrationSpec + Paths_ihaskell_symtegration + hs-source-dirs: + test + default-extensions: + OverloadedStrings + ghc-options: -Wall + build-tool-depends: + hspec-discover:hspec-discover ==2.* + build-depends: + base >=4.9 && <4.22 + , hspec ==2.* + , ihaskell >=0.11 && <0.13 + , ihaskell-symtegration + , symtegration ==0.6.* + , text >=1 && <3 + default-language: GHC2021 diff --git a/src/IHaskell/Display/Symtegration.hs b/src/IHaskell/Display/Symtegration.hs new file mode 100644 --- /dev/null +++ b/src/IHaskell/Display/Symtegration.hs @@ -0,0 +1,43 @@ +{-# OPTIONS_GHC -fno-warn-orphans #-} + +-- | +-- Module: IHaskell.Display.Symtegration +-- Description: IHaskell extension for making the use of Symtegration more seamless. +-- Copyright: Copyright 2025 Yoo Chung +-- License: Apache-2.0 +-- Maintainer: dev@chungyc.org +-- +-- This is an [IHaskell](https://github.com/IHaskell/IHaskell) extension to make +-- the use of [Symtegration](https://symtegration.dev/) more seamless. +-- In particular, it will render 'Expression' or 'Maybe' 'Expression' values +-- as mathematical expressions. +-- +-- For example, the following integrates to an 'Expression' in a 'Just' value, +-- which is rendered as a mathematical expression. +-- +-- ![Example of integral rendered by IHaskell](docs/integration-example.png) +-- +-- If an integral cannot be derived, i.e., 'integrate' returns 'Nothing', +-- then the bottom symbol \(\bot\) will be displayed. +module IHaskell.Display.Symtegration () where + +import Data.Text (unpack) +import IHaskell.Display +import Symtegration + +-- | Typesets 'Expression' values as mathematical expressions. +instance IHaskellDisplay Expression where + display expr = pure $ Display $ latexDisplayData expr <> haskellDisplayData expr + +-- | Typesets an 'Expression' even if it is a 'Maybe' value. +instance IHaskellDisplay (Maybe Expression) where + display (Just e) = display e + display Nothing = pure $ Display [latex "\\[\\bot\\]", plain "Nothing"] + +-- | Returns display data for the expression as LaTeX. +latexDisplayData :: Expression -> [DisplayData] +latexDisplayData expr = [latex $ "\\[" <> unpack (toLaTeX expr) <> "\\]"] + +-- | Returns display data for the expression as Haskell code. +haskellDisplayData :: Expression -> [DisplayData] +haskellDisplayData expr = [plain $ unpack $ toHaskell expr] diff --git a/test/IHaskell/Display/SymtegrationSpec.hs b/test/IHaskell/Display/SymtegrationSpec.hs new file mode 100644 --- /dev/null +++ b/test/IHaskell/Display/SymtegrationSpec.hs @@ -0,0 +1,23 @@ +module IHaskell.Display.SymtegrationSpec (spec) where + +import IHaskell.Display +import IHaskell.Display.Symtegration () +import Symtegration +import Test.Hspec + +spec :: Spec +spec = parallel $ do + describe "display" $ do + describe "Expression" $ do + it "exp 2" $ + display (exp 2 :: Expression) + `shouldReturn` Display [latex "\\[e^{2}\\]", plain "exp 2"] + + describe "Maybe Expression" $ do + it "Just (exp 2)" $ + display (Just (exp 2 :: Expression)) + `shouldReturn` Display [latex "\\[e^{2}\\]", plain "exp 2"] + + it "Nothing" $ + display (Nothing :: Maybe Expression) + `shouldReturn` Display [latex "\\[\\bot\\]", plain "Nothing"] diff --git a/test/Spec.hs b/test/Spec.hs new file mode 100644 --- /dev/null +++ b/test/Spec.hs @@ -0,0 +1,1 @@ +{-# OPTIONS_GHC -F -pgmF hspec-discover #-}