Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class Int32sRef

    Represents int[], as a slice (offset + length) into an existing int[]. The Int32s member should never be null; use EMPTY_INT32S if necessary.

    NOTE: This was IntsRef in Lucene

    Note

    This API is for internal purposes only and might change in incompatible ways in the next release.

    Inheritance
    object
    Int32sRef
    Implements
    IComparable<Int32sRef>
    Inherited Members
    object.Equals(object, object)
    object.GetType()
    object.ReferenceEquals(object, object)
    Namespace: Lucene.Net.Util
    Assembly: Lucene.Net.dll
    Syntax
    [Serializable]
    public sealed class Int32sRef : IComparable<Int32sRef>

    Constructors

    Int32sRef()

    Create a Int32sRef with EMPTY_INT32S.

    Declaration
    public Int32sRef()

    Int32sRef(int)

    Create a Int32sRef pointing to a new array of size capacity. Offset and length will both be zero.

    Declaration
    public Int32sRef(int capacity)
    Parameters
    Type Name Description
    int capacity

    Int32sRef(int[], int, int)

    This instance will directly reference ints w/o making a copy. ints should not be null.

    Declaration
    public Int32sRef(int[] ints, int offset, int length)
    Parameters
    Type Name Description
    int[] ints
    int offset
    int length

    Fields

    EMPTY_INT32S

    An empty integer array for convenience.

    NOTE: This was EMPTY_INTS in Lucene
    Declaration
    public static readonly int[] EMPTY_INT32S
    Field Value
    Type Description
    int[]

    Properties

    Int32s

    The contents of the Int32sRef. Should never be null.

    NOTE: This was ints (field) in Lucene
    Declaration
    public int[] Int32s { get; set; }
    Property Value
    Type Description
    int[]

    Length

    Length of used ints.

    Declaration
    public int Length { get; set; }
    Property Value
    Type Description
    int

    Offset

    Offset of first valid integer.

    Declaration
    public int Offset { get; set; }
    Property Value
    Type Description
    int

    Methods

    Clone()

    Returns a shallow clone of this instance (the underlying ints are not copied and will be shared by both the returned object and this object.

    Declaration
    public object Clone()
    Returns
    Type Description
    object
    See Also
    DeepCopyOf(Int32sRef)

    CompareTo(Int32sRef)

    Signed int order comparison.

    Declaration
    public int CompareTo(Int32sRef other)
    Parameters
    Type Name Description
    Int32sRef other
    Returns
    Type Description
    int

    CopyInt32s(Int32sRef)

    NOTE: This was copyInts() in Lucene

    Declaration
    public void CopyInt32s(Int32sRef other)
    Parameters
    Type Name Description
    Int32sRef other

    DeepCopyOf(Int32sRef)

    Creates a new Int32sRef that points to a copy of the ints from other

    The returned Int32sRef will have a length of other.Length and an offset of zero.
    Declaration
    public static Int32sRef DeepCopyOf(Int32sRef other)
    Parameters
    Type Name Description
    Int32sRef other
    Returns
    Type Description
    Int32sRef

    Equals(object)

    Determines whether the specified object is equal to the current object.

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    object obj

    The object to compare with the current object.

    Returns
    Type Description
    bool

    true if the specified object is equal to the current object; otherwise, false.

    Overrides
    object.Equals(object)

    GetHashCode()

    Serves as the default hash function.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    int

    A hash code for the current object.

    Overrides
    object.GetHashCode()

    Grow(int)

    Used to grow the reference array.

    In general this should not be used as it does not take the offset into account.

    Note

    This API is for internal purposes only and might change in incompatible ways in the next release.

    Declaration
    public void Grow(int newLength)
    Parameters
    Type Name Description
    int newLength

    Int32sEquals(Int32sRef)

    NOTE: This was intsEquals() in Lucene

    Declaration
    public bool Int32sEquals(Int32sRef other)
    Parameters
    Type Name Description
    Int32sRef other
    Returns
    Type Description
    bool

    IsValid()

    Performs internal consistency checks. Always returns true (or throws InvalidOperationException)

    Declaration
    public bool IsValid()
    Returns
    Type Description
    bool

    ToString()

    Returns a string that represents the current object.

    Declaration
    public override string ToString()
    Returns
    Type Description
    string

    A string that represents the current object.

    Overrides
    object.ToString()

    Implements

    IComparable<T>
    Back to top Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.