typequux.ArityZipOps.scala Maven / Gradle / Ivy

Go to download
/**
  * Copyright 2019 Harshad Deo
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  * http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
package typequux

import constraint._

/** Provided arbitrary arity zips for sequentially indexed arbitrary arity types, like [[HList]] or Tuples
  *
  * @tparam Z Type on which operations are defined
  * @tparam F Down-converted type of Z. For more, see [[constraint.DownTransformConstraint]]
  *
  * @author Harshad Deo
  * @since 0.1
  */
class ArityZipOps[Z, F](z: Z)(implicit ev: DownTransformConstraint[Z, F, Traversable]) {

  /** Zip and apply a transformation on the result
    *
    * @tparam T Element type of the resultant collection
    * @tparam V Type of the resultant collection
    *
    * @group Transformation
    * @author Harshad Deo
    * @since 0.1
    */
  def zipwith[T, V](f: F => T)(implicit ev: InternalZipConstraint[Z, F, T, V]): V = ev(z, f)

  /** Arbitrary arity zipped
    *
    * @tparam V Type of the resultant collection
    *
    * @group Transformation
    * @author Harshad Deo
    * @since 0.1
    */
  def azipped[V](implicit ev: InternalZipConstraint[Z, F, F, V]): V = zipwith(identity)
}