org.jetbrains.kotlinx.ggdsl.dsl.scale.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ggdsl-api Show documentation
Kotlin plotting DSL.
There is a newer version: 0.4.0-dev-15
/*
* Copyright 2020-2022 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/

package org.jetbrains.kotlinx.ggdsl.dsl

import org.jetbrains.kotlinx.ggdsl.dsl.internal.typed
import org.jetbrains.kotlinx.ggdsl.dsl.internal.typedList
import org.jetbrains.kotlinx.ggdsl.ir.scale.*

/**
 * Creates a new unspecified (i.e. without specifying the type and parameters;
 * they will be defined automatically) continuous non-positional scale.
 *
 * @param transform the transformation of scale
 */
public fun continuous(transform: NonPositionalTransform? = null): NonPositionalContinuousUnspecifiedScale =
    NonPositionalContinuousUnspecifiedScale(transform)

/**
 * Creates a new unspecified (i.e. without specifying the type and parameters;
 * * they will be defined automatically) categorical non-positional scale
 */
public fun categorical(): NonPositionalCategoricalUnspecifiedScale = NonPositionalCategoricalUnspecifiedScale

/**
 * Creates a new unspecified (i.e. without specifying the type and parameters;
 * they will be defined automatically) continuous positional scale
 *
 * @param transform the transformation of scale
 */
public fun continuousPos(transform: PositionalTransform? = null): PositionalContinuousUnspecifiedScale =
    PositionalContinuousUnspecifiedScale(transform)

/**
 * Creates a new unspecified (i.e. without specifying the type and parameters;
 * they will be defined automatically) categorical positional scale
 */
public fun categoricalPos(): PositionalCategoricalUnspecifiedScale =
    PositionalCategoricalUnspecifiedScale

/**
 * Creates a new continuous positional scale
 *
 * @param DomainType type of domain
 * @param limits segment defining the domain
 * @param transform the transformation of scale
 * @return new [PositionalContinuousScale] with given limits
 */
public inline fun  continuousPos(
    limits: Pair? = null,
    transform: PositionalTransform? = null
): PositionalContinuousScale = PositionalContinuousScale(limits?.let {
    it.first.typed() to it.second.typed()
}, transform)

/**
 * Creates a new continuous non-positional scale
 *
 * @param DomainType type of domain
 * @param RangeType type of range
 * @param domainLimits segment defining the domain
 * @param rangeLimits segment defining the range
 * @param transform the transformation of scale
 * @return new [NonPositionalContinuousScale] with given limits
 */
public inline fun  continuous(
    domainLimits: Pair? = null,
    rangeLimits: Pair? = null,
    transform: NonPositionalTransform? = null
): NonPositionalContinuousScale =
    NonPositionalContinuousScale(domainLimits?.let {
        it.first.typed() to it.second.typed()
    }, rangeLimits?.let {
        it.first.typed() to it.second.typed()
    }, transform)

/**
 * Creates a new categorical positional scale
 *
 * @param DomainType type of domain
 * @param categories [List] defining the domain
 * @return new [PositionalCategoricalScale] with given categories
 */
public inline fun  categoricalPos(categories: List? = null)
        : PositionalCategoricalScale =
    PositionalCategoricalScale(categories?.typedList())

/**
 * Creates a new categorical non-positional scale.
 *
 * @param DomainType type of domain
 * @param RangeType type of range
 * @param domainCategories [List] defining the domain
 * @param rangeValues [List] defining the range
 * @return new [NonPositionalCategoricalScale] with given limits
 */
public inline fun  categorical(
    domainCategories: List? = null,
    rangeValues: List? = null,
): NonPositionalCategoricalScale =
    NonPositionalCategoricalScale(domainCategories?.typedList(), rangeValues?.typedList())

/**
 * Creates a new categorical non-positional scale.
 *
 * @param DomainType type of domain
 * @param RangeType type of range
 * @param categoriesToValues [List] of pairs of category to corresponding value.
 * @return new [NonPositionalCategoricalScale] with given limits
 */
public inline fun  categorical(
    categoriesToValues: List>
): NonPositionalCategoricalScale =
    NonPositionalCategoricalScale(
        categoriesToValues.map { it.first }.typedList(),
        categoriesToValues.map { it.second }.typedList()
    )