1. Introduction
  2. User Guide
    1. Language Syntax
  3. API Reference
    1. General Functions
    2. Math Functions
    3. Memory Functions
    4. Misc Functions
    5. Vector Functions
    6. Types Functions
    7. All Module
    8. Csv Module
    9. Currencies Module
    10. Files Module
    11. StandardUnits Module
    12. Strings Module
    13. Web Module
    14. Intel Hardware Intrinsics
      1. Intel Aes Intrinsics
      2. Intel Avx Intrinsics
      3. Intel Avx2 Intrinsics
      4. Intel Bmi1 Intrinsics
      5. Intel Bmi1X64 Intrinsics
      6. Intel Bmi2 Intrinsics
      7. Intel Bmi2X64 Intrinsics
      8. Intel Sse Intrinsics
      9. Intel SseX64 Intrinsics
      10. Intel Sse2 Intrinsics
      11. Intel Sse2X64 Intrinsics
      12. Intel Sse3 Intrinsics
      13. Intel Ssse3 Intrinsics
      14. Intel Sse41 Intrinsics
      15. Intel Sse41X64 Intrinsics
      16. Intel Sse42 Intrinsics
      17. Intel Sse42X64 Intrinsics
    15. Arm Hardware Intrinsics
      1. Arm AdvSimd Intrinsics
      2. Arm AdvSimdArm64 Intrinsics
      3. Arm Aes Intrinsics
      4. Arm Crc32 Intrinsics
      5. Arm Crc32Arm64 Intrinsics
      6. Arm Sha1 Intrinsics
      7. Arm Sha256 Intrinsics
  4. Advanced Topics
  1. Home
  2. Introduction

Documentation

Welcome to the documentation of kalk!

kalk is a powerful command line calculator app for developers. In addition to the standard functions found in classic calculators, kalk provides several unique features:

  • Enhanced user experience within the command line: syntax highlighting, completion, brace matching, cursor on error, user defined keyboard shortcuts...
  • Vector/matrix types and functions similar to the HLSL shading language
  • x86 Intel Hardware intrinsics from SSE to AVX2
  • Several other modules to manipulate strings, perform web queries, file operations, currencies and standard units conversions...

This documentation is organized with the following parts:

  • A user guide explains how to use kalk and presents an overview of its features.
  • A reference API provides a complete listing of all builtin functions exposed by kalk.

You can participate in improving this documentation by clicking the "Edit" button on the right side of each page and open a Pull-Request directly on GitHub.