001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.imaging.color;
018
019/**
020 * Represents a color in the CIELAB color space, also
021 * known as LAB color space.
022 *
023 * <p>Contains the constant values for black, white, red,
024 * green, and blue.</p>
025 *
026 * @see <a href="https://en.wikipedia.org/wiki/CIELAB_color_space#CIELAB">https://en.wikipedia.org/wiki/CIELAB_color_space#CIELAB</a>
027 * @since 1.0-alpha1
028 */
029public final class ColorCieLab {
030
031    /**
032     * A constant for color black. Color components are:
033     * <pre>
034     *     L: 0
035     *     a: 0
036     *     b: 0
037     * </pre>
038     */
039    public static final ColorCieLab BLACK = new ColorCieLab(0, 0, 0);
040
041    /**
042     * A constant for color white. Color components are:
043     * <pre>
044     *     L: 100
045     *     a: 0
046     *     b: 0
047     * </pre>
048     */
049    public static final ColorCieLab WHITE = new ColorCieLab(100, 0, 0);
050
051    /**
052     * A constant for color red. Color components are:
053     * <pre>
054     *     L: 53
055     *     a: 80
056     *     b: 67
057     * </pre>
058     */
059    public static final ColorCieLab RED = new ColorCieLab(53, 80, 67);
060
061    /**
062     * A constant for color green. Color components are:
063     * <pre>
064     *     L:  88
065     *     a: -86
066     *     b:  83
067     * </pre>
068     */
069    public static final ColorCieLab GREEN = new ColorCieLab(88, -86, 83);
070
071    /**
072     * A constant for color blue. Color components are:
073     * <pre>
074     *     L:   32
075     *     a:   79
076     *     b: -108
077     * </pre>
078     */
079    public static final ColorCieLab BLUE = new ColorCieLab(32, 79, -108);
080
081    public final double L;
082    public final double a;
083    public final double b;
084
085    public ColorCieLab(final double L, final double a, final double b) {
086        this.L = L;
087        this.a = a;
088        this.b = b;
089    }
090
091    @Override
092    public String toString() {
093        return "{L: " + L + ", a: " + a + ", b: " + b + "}";
094    }
095
096    @Override
097    public boolean equals(final Object o) {
098        if (this == o) {
099            return true;
100        }
101        if (o == null || getClass() != o.getClass()) {
102            return false;
103        }
104
105        final ColorCieLab that = (ColorCieLab) o;
106        if (Double.compare(that.L, L) != 0) {
107            return false;
108        }
109        if (Double.compare(that.a, a) != 0) {
110            return false;
111        }
112        if (Double.compare(that.b, b) != 0) {
113            return false;
114        }
115
116        return true;
117    }
118
119    @Override
120    public int hashCode() {
121        int result;
122        long temp;
123        temp = Double.doubleToLongBits(L);
124        result = (int) (temp ^ (temp >>> 32));
125        temp = Double.doubleToLongBits(a);
126        result = 31 * result + (int) (temp ^ (temp >>> 32));
127        temp = Double.doubleToLongBits(b);
128        result = 31 * result + (int) (temp ^ (temp >>> 32));
129        return result;
130    }
131}