Skip to content

kotlin-graphics/kotlin-unsigned

Repository files navigation

kotlin-unsigned

Build Status license Release Size Github All Releases Slack Status

Unsigned operators and boxed types (Ubyte, Uint, Ulong and Ushort) for unsigned support.

To have a quick idea what this library offers, take a look at the tests

Differences with kotlin stdlib:

  • this project uses classes instead inline classes. To address this in critical scenarios where allocations may have a sensitive impact, primitive variable holding the utype value is a var, so you can re-use the same istance over and over again
  • utypes extend Number abstract class
  • automatic conversions
  • it is possible to string format by calling the corresponding format() method, eg: ubyte.format("%08x")
  • all the utypes implement all the function, including shl and shr for Ubyte and Ushort
  • if you add an Ushort to another Ushort you get an Ushort (and not an `Uint)
  • no unsigned arrays supported yet

How to get it:

Gradle

  • Add it in your root build.gradle at the end of repositories:

    allprojects {
        repositories {
            ...
            maven { url 'https://jitpack.io' } // should be the last entry
        }
    }
    
  • Add the dependency

    dependencies {
        compile 'com.github.kotlin-graphics:kotlin-unsigned:v2.1'
    }
    

Maven, Sbt, Leiningen

Hightlights:

Android compatible, sources compiled with java 1.7.

All unsigned methods available for ints and longs on java 1.8 have been reported here.

These are offered directly on the corresponding Int and Long Kotlin primitives (with infix too)

Contributions:

Don't hesitate to contribute to the project by submitting issues or pull requests for bugs and features. Any feedback is welcome at [email protected].

Credits: