lphy.base.evolution.NChar Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lphy-base Show documentation

The standard library of LPhy, which contains the required generative distributions and basic functions.

The newest version!

package lphy.base.evolution;

import lphy.core.model.annotation.GeneratorCategory;
import lphy.core.model.annotation.MethodInfo;
import lphy.core.model.annotation.TypeInfo;

/**
 * An interface that site-dimensioned objects can implement, such as Alignment.
 */
@TypeInfo(description = "An interface that site-dimensioned objects can implement, such as Alignment.",
        examples = {"simpleSerialCoalescentNex.lphy"})
public interface NChar {

    /**
     * @return the number of sites this object has.
     */
    @MethodInfo(description="The number of characters/sites.", narrativeName = "number of characters",
            category = GeneratorCategory.TAXA_ALIGNMENT, examples = {"simpleSerialCoalescentNex.lphy"})
    Integer nchar();
}