الدالة foldRightIndexed()‎ في Kotlin

تجمع الدالة foldRightIndexed()‎ ناتج تطبيق عملية معينة على قيمة كل عنصر من عناصر المصفوفة أو المجموعة (بدءًا من اليمين إلى اليسار) المستدعاة معها وفهرس ذلك العنصر بشكل تراكمي بالإضافة إلى القيمة الأولية إن أعطيت. 

البنية العامة

يمكن استدعاء الدالة foldRightIndexed()‎ مع المصفوفات:

inline fun <T, R> Array<out T>.foldRightIndexed(
    initial: R, 
    operation: (index: Int, T, acc: R) -> R
): R
inline fun <R> ByteArray.foldRightIndexed(
    initial: R, 
    operation: (index: Int, Byte, acc: R) -> R
): R 
inline fun <R> ShortArray.foldRightIndexed(
    initial: R, 
    operation: (index: Int, Short, acc: R) -> R
): R 
inline fun <R> IntArray.foldRightIndexed(
    initial: R, 
    operation: (index: Int, Int, acc: R) -> R
): R 
inline fun <R> LongArray.foldRightIndexed(
    initial: R, 
    operation: (index: Int, Long, acc: R) -> R
): R 
inline fun <R> FloatArray.foldRightIndexed(
    initial: R, 
    operation: (index: Int, Float, acc: R) -> R
): R 
inline fun <R> DoubleArray.foldRightIndexed(
    initial: R, 
    operation: (index: Int, Double, acc: R) -> R
): R 
inline fun <R> BooleanArray.foldRightIndexed(
    initial: R, 
    operation: (index: Int, Boolean, acc: R) -> R
): R 
inline fun <R> CharArray.foldRightIndexed(
    initial: R, 
    operation: (index: Int, Char, acc: R) -> R
): R

ويمكن استدعاؤها مع المجموعات أيضًا:

inline fun <T, R> List<T>.foldRightIndexed(
    initial: R, 
    operation: (index: Int, T, acc: R) -> R
): R

وجود الكلمة المفتاحية inline يدل على أنَّ هذه الدالة مباشرة (للمزيد من التفاصيل، راجع صفحة الدوال المباشرة (inline functions)).

المعاملات

initial

قيمة أولية يراد إضافتها مع ناتج تطبيق الدالة operation على أول عنصر من عناصر المصفوفة أو المجموعة المعطاة لبدء عملية التجميع.

operation

دالةٌ تمثل العملية المراد تطبيقها على كل عنصر من عناصر المصفوفة أو المجموعة المعطاة، إذ يمرَّر إليها فهرس العنصر index، وقيمة كل عنصر من عناصر المصفوفة أو المجموعة المعطاة T، والقيمة المجمعة الحالية acc، ثم تعيد القيمة المجمَّعة acc التالية.

القيم المعادة

يعاد الناتج النهائي التراكمي لتطبيق العملية operation المعطاة على كل عنصر من عناصر مصفوفة أو مجموعة (بدءًا من اليمين إلى اليسار) مع فهرس ذلك العنصر مضافًا إليه القيمة الأولية initial إن أعطيت. 

أمثلة

تعرِّف الشيفرة الآتية مصفوفة باسم array باستخدام الدالة ()arrayOf، ثم تستخدم الدالة ()foldRightIndexed لجمع ناتج ضرب قيمة كل عنصر من عناصر تلك الصفوفة بفهرسه تراكميًّا:

fun main(args: Array<String>) {
    val array = arrayOf(1, 2, 3, 4, 5, 6)

    val acc = array.foldRightIndexed(0) { acc, element, index -> acc + element * index }
    print(acc) // 719
}

انظر أيضًا

• الدالة foldIndexed()‎: تجمع ناتج تطبيق عملية معينة على قيمة كل عنصر من عناصر المصفوفة أو المجموعة (بدءًا من اليسار إلى اليمين) المستدعاة معها وفهرس ذلك العنصر بشكل تراكمي بالإضافة إلى القيمة الأولية إن أعطيت.
• الدالة foldRight()‎: تجمع بشكل تراكمي ناتج تطبيق عملية معيَّنة على قيمة كل عنصر من عناصر المصفوفة أو المجموعة (بدءًا من اليمين إلى اليسار) المستدعاة معها والقيمة التراكمية الحالية بالإضافة إلى القيمة الأولية إن أعطيت. 
• الدالة reduceRightIndexed()‎: تجمع الناتج التراكمي لتطبيق عملية معينة على قيمة كل عنصر من عناصر المصفوفة أو المجموعة (بدءًا من اليمين إلى اليسار) المستدعاة معها وفهرس ذلك العنصر والقيمة المجمَّعة الحالية.

مصادر

• صفحة الدالة foldRightIndexed()‎ في التوثيق الرسميّ للمكتبة القياسيّة في لغة Kotlin.