Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/symcalc/symcalc-ruby
Symbolic mathematics and calculus in Ruby
https://github.com/symcalc/symcalc-ruby
calculus differentiation mathematics maths ruby symcalc
Last synced: 22 days ago
JSON representation
Symbolic mathematics and calculus in Ruby
- Host: GitHub
- URL: https://github.com/symcalc/symcalc-ruby
- Owner: symcalc
- License: apache-2.0
- Created: 2024-07-24T13:33:03.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-07-29T11:25:52.000Z (3 months ago)
- Last Synced: 2024-10-01T16:46:04.823Z (about 1 month ago)
- Topics: calculus, differentiation, mathematics, maths, ruby, symcalc
- Language: Ruby
- Homepage: https://symcalc.site/ruby
- Size: 50.8 KB
- Stars: 10
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SymCalc Ruby
[Website](https://symcalc.site/ruby)
/
[License: Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0)
/
[Changelog](https://symcalc.site/ruby/changelog)
/
[Ruby](https://github.com/symcalc/symcalc-ruby)
,
[C++](https://github.com/symcalc/symcalc-cpp)
SymCalc (which stands for **Sym**bolic **Calc**ulus) is a library that introduces mathematics to code, where you can declare, evaluate, and differentiate any possible maths function with a single call.
SymCalc allows to write readable and flexible code, adding a lot of functionality along the way, like this:
```ruby
fx = 5 * x ** 2 + sin(x)
```
Instead of hard-coded functions like this:
```ruby
def fx(x)
5 * x ** 2 + Math.sin(x)
end
```
## Contents
- [Example](#example)
- [Basic usage](#basic-usage)
- [Install](#install-with-make)
- [Learning SymCalc](#learning-symcalc)
- [Authors](#authors)
## Example
```ruby
require 'symcalc'
include SymCalc
# SymCalc variable
x = var("x")
# SymCalc function
fx = x ** 2 * 5 - 4 * sin(exp(x))
# SymCalc derivative
dfdx = fx.derivative()
# SymCalc evaluate
value = dfdx.eval x: 5
puts value
```
## Basic usage
1. Require SymCalc:
```ruby
require 'symcalc'
include SymCalc
```
2. Define a variable:
```ruby
x = var("x")
```
3. Define a function:
```ruby
fx = x ** 2
```
4. Evaluate:
```ruby
value = fx.eval(x: 4)
# or
value = fx(x: 4)
```
5. Differentiate:
```ruby
dfdx = fx.derivative
```
6. Multi-variable!:
```ruby
x = var("x")
y = var("y")
fxy = x ** 2 - 4 * abs(y)
dfdx = fxy.derivative(variable: x)
dfdy = fxy.derivative(variable: y)
```
7. Display:
```ruby
puts fx # Prints the function
```
8. Run:
```bash
ruby main.rb
```
9. See more on the [website](https://symcalc.site/ruby)!
## Install
Run:
```bash
gem install symcalc
```
## Learning SymCalc
You can learn more about SymCalc on these resources:
- [SymCalc's Website](https://symcalc.site/ruby)
- [Intro](https://symcalc.site/ruby/intro)
- [Examples](https://symcalc.site/ruby/examples)
- [Docs](https://symcalc.site/ruby/docs)
## Authors
SymCalc is currently developed and maintaned by [Kyryl Shyshko](https://kyrylshyshko.me) ([@kyryloshy](https://github.com/kyryloshy))