commonMain.org.jetbrains.letsPlot.util.pngj.IImageLineArray.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lets-plot-kotlin-kernel Show documentation

Lets-Plot Kotlin API without dependencies.

There is a newer version: 4.8.0

Show newest version

/*
 * Copyright (c) 2023 JetBrains s.r.o.
 * Use of this source code is governed by the MIT license that can be found in the LICENSE file.
 *
 * This file has been modified by JetBrains : Java code has been converted to Kotlin code.
 *
 * THE FOLLOWING IS THE COPYRIGHT OF THE ORIGINAL DOCUMENT:
 *
 * Copyright (c) 2009-2012, Hernán J. González.
 * Licensed under the Apache License, Version 2.0.
 *
 * The original PNGJ library is written in Java and can be found here: [PNGJ](https://github.com/leonbloy/pngj).
 */

package org.jetbrains.letsPlot.util.pngj

/**
 * This interface is just for the sake of unifying some methods of
 * [ImageLineHelper] that can use both [ImageLineInt] or
 * [ImageLineByte]. It's not very useful outside that, and the user should
 * not rely much on this.
 */
internal interface IImageLineArray {
    val imageInfo: ImageInfo
    val filterType: FilterType

    /**
     * length of array (should correspond to samples)
     */
    val size: Int

    /**
     * Get i-th element of array (for 0 to size-1). The meaning of this is type
     * dependent. For ImageLineInt and ImageLineByte is the sample value.
     */
    fun getElem(i: Int): Int
}