Skip to content

machitgarha/farsang

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Farsang

Release

GSL (i.e. GNU Scientific Library) with C++ taste.

Farsang is a C++ wrapper for GSL, with classes and exceptions in mind.

Implemented

  • Exception mechanism
  • Random generators
  • Random Distributions
    • Gamma
    • Gaussin
    • Poisson

Build

Requirements

  • CMake
  • Makefile
  • C++ Compiler (GCC is recommended)

Supported Platforms

  • Linux

Shared

Prepare CMake:

cmake . -B build

Make it:

make -C build

You'll have an .so file. Use it wherever you need.

Documentation?

As you might know, a comprehensive documentation is available for GSL. If you are familiar with that, then you should understand how Farsang works in a short time.

Currently, there is no documentation available for Farsang. However, if you are interested in writing one, create an issue or pull request, we will appreciate your effort.

Contributions?

Great!

You're pretty much welcomed to contribute to this project, either by creating an issue or a pull request.

Priorities

Consider these as first things to contribute:

  • Adding tests.
  • Improving code documentation.
  • Implementing unimplemented stuff from GSL.
  • Port for other platforms.

License

Well, just like GSL itself, Farsang is under GPLv3.

Miscellaneous

Naming?

Farsang is a historical unit of distance in Iran.

A tiny history?

As a result of a university homework, this project was created.

PHP here?

Yes: For the automation of creating exception classes, there is a simple PHP script included in this project. Using something saving your time is always good.